MediaWiki master
MediaWiki\Parser\PPCustomFrame_Hash Class Reference

Expansion frame with custom arguments. More...

Inherits MediaWiki\Parser\PPFrame_Hash.

Collaboration diagram for MediaWiki\Parser\PPCustomFrame_Hash:

Public Member Functions

 __construct ( $preprocessor, $args)
 __toString ()
 getArgument ( $index)
 getArguments ()
 
Returns
array

 isEmpty ()
Public Member Functions inherited from MediaWiki\Parser\PPFrame_Hash
 __construct ( $preprocessor)
 cachedExpand ( $key, $root, $flags=0)
 expand ( $root, $flags=0)
 getNamedArguments ()
 getNumberedArguments ()
 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)
 isTemplate ()
 Return true if the frame is a template frame.
 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.
 setTTL ( $ttl)
 setVolatile ( $flag=true)
 Set the volatile flag.
 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 $args
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 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 custom arguments.

Definition at line 15 of file PPCustomFrame_Hash.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Parser\PPCustomFrame_Hash::__construct ( $preprocessor,
$args )
Parameters
Preprocessor$preprocessor
array$args

Definition at line 24 of file PPCustomFrame_Hash.php.

References $args, and MediaWiki\Parser\PPFrame_Hash\$preprocessor.

Member Function Documentation

◆ __toString()

MediaWiki\Parser\PPCustomFrame_Hash::__toString ( )

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 29 of file PPCustomFrame_Hash.php.

◆ getArgument()

MediaWiki\Parser\PPCustomFrame_Hash::getArgument ( $index)
Parameters
int | string$index
Returns
string|false

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 56 of file PPCustomFrame_Hash.php.

◆ getArguments()

MediaWiki\Parser\PPCustomFrame_Hash::getArguments ( )

Returns
array

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 61 of file PPCustomFrame_Hash.php.

References $args.

◆ isEmpty()

MediaWiki\Parser\PPCustomFrame_Hash::isEmpty ( )
Returns
bool

Reimplemented from MediaWiki\Parser\PPFrame_Hash.

Definition at line 48 of file PPCustomFrame_Hash.php.

Member Data Documentation

◆ $args

array MediaWiki\Parser\PPCustomFrame_Hash::$args

Definition at line 18 of file PPCustomFrame_Hash.php.

Referenced by __construct(), and getArguments().


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