MediaWiki master
Public Member Functions | Public Attributes | List of all members
MediaWiki\Parser\PPTemplateFrame_Hash Class Reference
Parser

Expansion frame with template arguments. More...

Inherits MediaWiki\Parser\PPFrame_Hash.

Collaboration diagram for MediaWiki\Parser\PPTemplateFrame_Hash:
Collaboration graph
[legend]

Public Member Functions

 __construct ( $preprocessor, $parent=false, $numberedArgs=[], $namedArgs=[], $title=false)
 
 __toString ()
 
 cachedExpand ( $key, $root, $flags=0)
 
 getArgument ( $name)
 
 getArguments ()
 
 getNamedArgument ( $name)
 
 getNamedArguments ()
 
 getNumberedArgument ( $index)
 
 getNumberedArguments ()
 
 isEmpty ()
 Returns true if there are no arguments in this frame.
 
 isTemplate ()
 Return true if the frame is a template frame.
 
 setTTL ( $ttl)
 
Parameters
int$ttl
Deprecated
since 1.44, use ParserOutput::updateCacheExpiry()

 
 setVolatile ( $flag=true)
 Set the volatile flag.
Parameters
bool$flag

 
- Public Member Functions inherited from MediaWiki\Parser\PPFrame_Hash
 __construct ( $preprocessor)
 
 expand ( $root, $flags=0)
 
 getPDBK ( $level=false)
 
 getTitle ()
 Get a title of frame.
 
 getTTL ()
 
 implode ( $sep,... $args)
 Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.
 
 implodeWithFlags ( $sep, $flags,... $args)
 
 isVolatile ()
 Get the volatile flag.
 
 loopCheck ( $title)
 Returns true if the infinite loop check is OK, false if a loop is detected.
 
 newChild ( $args=false, $title=false, $indexOffset=0)
 Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.
 
 virtualBracketedImplode ( $start, $sep, $end,... $args)
 Virtual implode with brackets.
 
 virtualImplode ( $sep,... $args)
 Makes an object that, when expand()ed, will be the same as one obtained with implode()
 

Public Attributes

array $namedArgs
 
array $namedExpansionCache
 
array $numberedArgs
 
array $numberedExpansionCache
 
PPFrame_Hash $parent
 
- Public Attributes inherited from MediaWiki\Parser\PPFrame_Hash
int $depth
 Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand()
 
true[] $loopCheckHash
 Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.
 
Parser $parser
 
Preprocessor $preprocessor
 
Title $title
 
string false[] $titleCache
 
- Public Attributes inherited from MediaWiki\Parser\PPFrame
const NO_ARGS = 1
 
const NO_IGNORE = 8
 
const NO_TAGS = 32
 
const NO_TEMPLATES = 2
 
const PROCESS_NOWIKI = 64
 
const RECOVER_COMMENTS = 16
 
const RECOVER_ORIG
 
const STRIP_COMMENTS = 4
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Parser\PPFrame_Hash
array $childExpansionCache
 

Detailed Description

Expansion frame with template arguments.

Definition at line 17 of file PPTemplateFrame_Hash.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Parser\PPTemplateFrame_Hash::__construct ( $preprocessor,
$parent = false,
$numberedArgs = [],
$namedArgs = [],
$title = false )
Parameters
Preprocessor$preprocessor
false | PPFrame$parent
array$numberedArgs
array$namedArgs
false | Title$title

Definition at line 37 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\$namedArgs, MediaWiki\Parser\PPTemplateFrame_Hash\$numberedArgs, MediaWiki\Parser\PPTemplateFrame_Hash\$parent, MediaWiki\Parser\PPFrame_Hash\$preprocessor, MediaWiki\Parser\PPFrame_Hash\$title, and MediaWiki\Title\Title\getPrefixedDBkey().

Member Function Documentation

◆ __toString()

MediaWiki\Parser\PPTemplateFrame_Hash::__toString ( )

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 59 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\$namedArgs.

◆ cachedExpand()

MediaWiki\Parser\PPTemplateFrame_Hash::cachedExpand ( $key,
$root,
$flags = 0 )
Parameters
string | int$key
string | PPNode$root
int$flags
Returns
string

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 82 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPFrame_Hash\expand(), and MediaWiki\Parser\PPFrame_Hash\isVolatile().

◆ getArgument()

MediaWiki\Parser\PPTemplateFrame_Hash::getArgument ( $name)
Parameters
int | string$name
Returns
string|false

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 175 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\getNamedArgument(), and MediaWiki\Parser\PPTemplateFrame_Hash\getNumberedArgument().

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\getArguments(), MediaWiki\Parser\PPTemplateFrame_Hash\getNamedArguments(), and MediaWiki\Parser\PPTemplateFrame_Hash\getNumberedArguments().

◆ getArguments()

MediaWiki\Parser\PPTemplateFrame_Hash::getArguments ( )
Returns
array

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 105 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\getArgument().

◆ getNamedArgument()

MediaWiki\Parser\PPTemplateFrame_Hash::getNamedArgument ( $name)
Parameters
string$name
Returns
string|false

Definition at line 159 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPFrame\STRIP_COMMENTS.

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\getArgument().

◆ getNamedArguments()

MediaWiki\Parser\PPTemplateFrame_Hash::getNamedArguments ( )
Returns
array

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 129 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\getArgument().

◆ getNumberedArgument()

MediaWiki\Parser\PPTemplateFrame_Hash::getNumberedArgument ( $index)
Parameters
int$index
Returns
string|false

Definition at line 141 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPFrame\STRIP_COMMENTS.

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\getArgument().

◆ getNumberedArguments()

MediaWiki\Parser\PPTemplateFrame_Hash::getNumberedArguments ( )
Returns
array

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 118 of file PPTemplateFrame_Hash.php.

References MediaWiki\Parser\PPTemplateFrame_Hash\getArgument().

◆ isEmpty()

MediaWiki\Parser\PPTemplateFrame_Hash::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns
bool

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 98 of file PPTemplateFrame_Hash.php.

◆ isTemplate()

MediaWiki\Parser\PPTemplateFrame_Hash::isTemplate ( )

Return true if the frame is a template frame.

Returns
bool

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 188 of file PPTemplateFrame_Hash.php.

◆ setTTL()

MediaWiki\Parser\PPTemplateFrame_Hash::setTTL ( $ttl)

Parameters
int$ttl
Deprecated
since 1.44, use ParserOutput::updateCacheExpiry()

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 199 of file PPTemplateFrame_Hash.php.

References wfDeprecated().

◆ setVolatile()

MediaWiki\Parser\PPTemplateFrame_Hash::setVolatile ( $flag = true)

Set the volatile flag.

Parameters
bool$flag

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 193 of file PPTemplateFrame_Hash.php.

Member Data Documentation

◆ $namedArgs

array MediaWiki\Parser\PPTemplateFrame_Hash::$namedArgs

Definition at line 22 of file PPTemplateFrame_Hash.php.

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\__construct(), and MediaWiki\Parser\PPTemplateFrame_Hash\__toString().

◆ $namedExpansionCache

array MediaWiki\Parser\PPTemplateFrame_Hash::$namedExpansionCache

Definition at line 28 of file PPTemplateFrame_Hash.php.

◆ $numberedArgs

array MediaWiki\Parser\PPTemplateFrame_Hash::$numberedArgs

Definition at line 20 of file PPTemplateFrame_Hash.php.

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\__construct().

◆ $numberedExpansionCache

array MediaWiki\Parser\PPTemplateFrame_Hash::$numberedExpansionCache

Definition at line 26 of file PPTemplateFrame_Hash.php.

◆ $parent

PPFrame_Hash MediaWiki\Parser\PPTemplateFrame_Hash::$parent

Definition at line 24 of file PPTemplateFrame_Hash.php.

Referenced by MediaWiki\Parser\PPTemplateFrame_Hash\__construct().

The documentation for this class was generated from the following file: