MediaWiki  master
PPTemplateFrame_Hash Class Reference

Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_Hash:
Collaboration diagram for PPTemplateFrame_Hash:

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. More...
 
 isTemplate ()
 Return true if the frame is a template frame. More...
 
 setTTL ( $ttl)
 Set the TTL. More...
 
 setVolatile ( $flag=true)
 Set the volatile flag. More...
 
- Public Member Functions inherited from PPFrame_Hash
 __construct ( $preprocessor)
 
 expand ( $root, $flags=0)
 
 getPDBK ( $level=false)
 
 getTitle ()
 Get a title of frame. More...
 
 getTTL ()
 Get the TTL. More...
 
 implode ( $sep,... $args)
 Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth. More...
 
 implodeWithFlags ( $sep, $flags,... $args)
 
 isVolatile ()
 Get the volatile flag. More...
 
 loopCheck ( $title)
 Returns true if the infinite loop check is OK, false if a loop is detected. More...
 
 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. More...
 
 virtualBracketedImplode ( $start, $sep, $end,... $args)
 Virtual implode with brackets. More...
 
 virtualImplode ( $sep,... $args)
 Makes an object that, when expand()ed, will be the same as one obtained with implode() More...
 

Public Attributes

 $namedArgs
 
 $namedExpansionCache
 
 $numberedArgs
 
 $numberedExpansionCache
 
 $parent
 
- Public Attributes inherited from PPFrame_Hash
 $depth
 Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand() More...
 
 $loopCheckHash
 Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames. More...
 
Parser $parser
 
Preprocessor $preprocessor
 
Title $title
 
 $titleCache
 
- Public Attributes inherited from 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 PPFrame_Hash
array $childExpansionCache
 

Detailed Description

Expansion frame with template arguments.

Definition at line 27 of file PPTemplateFrame_Hash.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 39 of file PPTemplateFrame_Hash.php.

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

Member Function Documentation

◆ __toString()

PPTemplateFrame_Hash::__toString ( )

Reimplemented from PPFrame_Hash.

Definition at line 61 of file PPTemplateFrame_Hash.php.

References $args, $namedArgs, and $s.

◆ cachedExpand()

PPTemplateFrame_Hash::cachedExpand (   $key,
  $root,
  $flags = 0 
)
Exceptions
MWException
Parameters
string | int$key
string | PPNode$root
int$flags
Returns
string

Reimplemented from PPFrame_Hash.

Definition at line 85 of file PPTemplateFrame_Hash.php.

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

◆ getArgument()

PPTemplateFrame_Hash::getArgument (   $name)
Parameters
int | string$name
Returns
string|bool

Reimplemented from PPFrame_Hash.

Definition at line 178 of file PPTemplateFrame_Hash.php.

References getNamedArgument(), and getNumberedArgument().

Referenced by getArguments(), getNamedArguments(), and getNumberedArguments().

◆ getArguments()

PPTemplateFrame_Hash::getArguments ( )
Returns
array

Reimplemented from PPFrame_Hash.

Definition at line 108 of file PPTemplateFrame_Hash.php.

References getArgument().

◆ getNamedArgument()

PPTemplateFrame_Hash::getNamedArgument (   $name)
Parameters
string$name
Returns
string|bool

Definition at line 162 of file PPTemplateFrame_Hash.php.

References PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

◆ getNamedArguments()

PPTemplateFrame_Hash::getNamedArguments ( )
Returns
array

Reimplemented from PPFrame_Hash.

Definition at line 132 of file PPTemplateFrame_Hash.php.

References getArgument().

◆ getNumberedArgument()

PPTemplateFrame_Hash::getNumberedArgument (   $index)
Parameters
int$index
Returns
string|bool

Definition at line 144 of file PPTemplateFrame_Hash.php.

References PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

◆ getNumberedArguments()

PPTemplateFrame_Hash::getNumberedArguments ( )
Returns
array

Reimplemented from PPFrame_Hash.

Definition at line 121 of file PPTemplateFrame_Hash.php.

References getArgument().

◆ isEmpty()

PPTemplateFrame_Hash::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns
bool

Reimplemented from PPFrame_Hash.

Definition at line 101 of file PPTemplateFrame_Hash.php.

◆ isTemplate()

PPTemplateFrame_Hash::isTemplate ( )

Return true if the frame is a template frame.

Returns
bool

Reimplemented from PPFrame_Hash.

Definition at line 191 of file PPTemplateFrame_Hash.php.

◆ setTTL()

PPTemplateFrame_Hash::setTTL (   $ttl)

Set the TTL.

Parameters
int$ttl

Reimplemented from PPFrame_Hash.

Definition at line 200 of file PPTemplateFrame_Hash.php.

References PPFrame_Hash\$ttl.

◆ setVolatile()

PPTemplateFrame_Hash::setVolatile (   $flag = true)

Set the volatile flag.

Parameters
bool$flag

Reimplemented from PPFrame_Hash.

Definition at line 195 of file PPTemplateFrame_Hash.php.

Member Data Documentation

◆ $namedArgs

PPTemplateFrame_Hash::$namedArgs

Definition at line 29 of file PPTemplateFrame_Hash.php.

Referenced by __construct(), and __toString().

◆ $namedExpansionCache

PPTemplateFrame_Hash::$namedExpansionCache

Definition at line 30 of file PPTemplateFrame_Hash.php.

◆ $numberedArgs

PPTemplateFrame_Hash::$numberedArgs

Definition at line 29 of file PPTemplateFrame_Hash.php.

Referenced by __construct().

◆ $numberedExpansionCache

PPTemplateFrame_Hash::$numberedExpansionCache

Definition at line 30 of file PPTemplateFrame_Hash.php.

◆ $parent

PPTemplateFrame_Hash::$parent

Definition at line 29 of file PPTemplateFrame_Hash.php.

Referenced by __construct().


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