| Server IP : 167.235.224.122 / Your IP : 216.73.216.110 Web Server : Apache/2.4.58 (Ubuntu) System : Linux newplayground 6.8.0-136-generic #136-Ubuntu SMP PREEMPT_DYNAMIC Wed Jul 1 21:33:11 UTC 2026 aarch64 User : deploy ( 1000) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/html/wiki/includes/parser/ |
Upload File : |
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Parser
*/
namespace MediaWiki\Parser;
use MediaWiki\Title\Title;
/**
* @ingroup Parser
*
* @property int $depth
* @property PPFrame $parent
*/
interface PPFrame {
public const NO_ARGS = 1;
public const NO_TEMPLATES = 2;
public const STRIP_COMMENTS = 4;
public const NO_IGNORE = 8;
public const RECOVER_COMMENTS = 16;
public const NO_TAGS = 32;
public const PROCESS_NOWIKI = 64;
public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
self::RECOVER_COMMENTS | self::NO_TAGS;
/**
* Create a child frame
*
* @param PPNode[]|false $args
* @param Title|false $title
* @param int $indexOffset A number subtracted from the index attributes of the arguments
*
* @return PPFrame
*/
public function newChild( $args = false, $title = false, $indexOffset = 0 );
/**
* Expand a document tree node, caching the result on its parent with the given key
* @param string|int $key
* @param string|PPNode $root
* @param int $flags
* @return string
*/
public function cachedExpand( $key, $root, $flags = 0 );
/**
* Expand a document tree node
* @param string|PPNode $root
* @param int $flags
* @return string
*/
public function expand( $root, $flags = 0 );
/**
* Implode with flags for expand()
* @param string $sep
* @param int $flags
* @param string|PPNode ...$params
* @return string
*/
public function implodeWithFlags( $sep, $flags, ...$params );
/**
* Implode with no flags specified
* @param string $sep
* @param string|PPNode ...$params
* @return string
*/
public function implode( $sep, ...$params );
/**
* Makes an object that, when expand()ed, will be the same as one obtained
* with implode()
* @param string $sep
* @param string|PPNode ...$params
* @return PPNode
*/
public function virtualImplode( $sep, ...$params );
/**
* Virtual implode with brackets
* @param string $start
* @param string $sep
* @param string $end
* @param string|PPNode ...$params
* @return PPNode
*/
public function virtualBracketedImplode( $start, $sep, $end, ...$params );
/**
* Returns true if there are no arguments in this frame
*
* @return bool
*/
public function isEmpty();
/**
* Returns all arguments of this frame
* @return array
*/
public function getArguments();
/**
* Returns all numbered arguments of this frame
* @return array
*/
public function getNumberedArguments();
/**
* Returns all named arguments of this frame
* @return array
*/
public function getNamedArguments();
/**
* Get an argument to this frame by name
* @param int|string $name
* @return string|false
*/
public function getArgument( $name );
/**
* Returns true if the infinite loop check is OK, false if a loop is detected
*
* @param Title $title
* @return bool
*/
public function loopCheck( $title );
/**
* Return true if the frame is a template frame
* @return bool
*/
public function isTemplate();
/**
* Set the "volatile" flag.
*
* Note that this is somewhat of a "hack" in order to make extensions
* with side effects (such as Cite) work with the PHP parser. New
* extensions should be written in a way that they do not need this
* function, because other parsers (such as Parsoid) are not guaranteed
* to respect it, and it may be removed in the future.
*
* @param bool $flag
*/
public function setVolatile( $flag = true );
/**
* Get the "volatile" flag.
*
* Callers should avoid caching the result of an expansion if it has the
* volatile flag set.
*
* @see self::setVolatile()
* @return bool
*/
public function isVolatile();
/**
* Get the TTL of the frame's output.
*
* This is the maximum amount of time, in seconds, that this frame's
* output should be cached for. A value of null indicates that no
* maximum has been specified.
*
* Note that this TTL only applies to caching frames as parts of pages.
* It is not relevant to caching the entire rendered output of a page.
*
* @return int|null
*/
public function getTTL();
/**
* Set the TTL of the output of this frame and all of its ancestors.
* Has no effect if the new TTL is greater than the one already set.
* Note that it is the caller's responsibility to change the cache
* expiry of the page as a whole, if such behavior is desired.
*
* @see self::getTTL()
* @param int $ttl
* @deprecated since 1.44; does not affect cache expiry in practice,
* and is unused in core code. Use ParserOutput::updateCacheExpiry()
* instead.
*/
public function setTTL( $ttl );
/**
* Get a title of frame
*
* @return Title
*/
public function getTitle();
}
/** @deprecated class alias since 1.43 */
class_alias( PPFrame::class, 'PPFrame' );