MediaWiki  REL1_31
PPTemplateFrame_DOM Class Reference

Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_DOM:
Collaboration diagram for PPTemplateFrame_DOM:

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_DOM
 __construct ( $preprocessor)
 Construct a new preprocessor frame. More...
 
 expand ( $root, $flags=0)
 
 getPDBK ( $level=false)
 
 getTitle ()
 Get a title of frame. More...
 
 getTTL ()
 Get the TTL. More...
 
 implode ( $sep)
 Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth. More...
 
 implodeWithFlags ( $sep, $flags)
 
 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)
 Virtual implode with brackets. More...
 
 virtualImplode ( $sep)
 Makes an object that, when expand()ed, will be the same as one obtained with implode() More...
 

Public Attributes

 $namedArgs
 
 $namedExpansionCache
 
 $numberedArgs
 
 $numberedExpansionCache
 
PPFrame_DOM $parent
 
- Public Attributes inherited from PPFrame_DOM
 $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 = 59
 
const STRIP_COMMENTS = 4
 
const SUPPORTS_INDEX_OFFSET = 1
 This constant exists when $indexOffset is supported in newChild() More...
 

Additional Inherited Members

- Protected Attributes inherited from PPFrame_DOM
array $childExpansionCache
 

Detailed Description

Expansion frame with template arguments.

Definition at line 1662 of file Preprocessor_DOM.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 1679 of file Preprocessor_DOM.php.

Member Function Documentation

◆ __toString()

PPTemplateFrame_DOM::__toString ( )

Reimplemented from PPFrame_DOM.

Definition at line 1699 of file Preprocessor_DOM.php.

◆ cachedExpand()

PPTemplateFrame_DOM::cachedExpand (   $key,
  $root,
  $flags = 0 
)
Exceptions
MWException
Parameters
string | int$key
string | PPNode_DOM | DOMDocument$root
int$flags
Returns
string

Reimplemented from PPFrame_DOM.

Definition at line 1723 of file Preprocessor_DOM.php.

◆ getArgument()

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

Reimplemented from PPFrame_DOM.

Definition at line 1807 of file Preprocessor_DOM.php.

◆ getArguments()

PPTemplateFrame_DOM::getArguments ( )
Returns
array

Reimplemented from PPFrame_DOM.

Definition at line 1743 of file Preprocessor_DOM.php.

◆ getNamedArgument()

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

Definition at line 1791 of file Preprocessor_DOM.php.

◆ getNamedArguments()

PPTemplateFrame_DOM::getNamedArguments ( )
Returns
array

Reimplemented from PPFrame_DOM.

Definition at line 1761 of file Preprocessor_DOM.php.

◆ getNumberedArgument()

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

Definition at line 1773 of file Preprocessor_DOM.php.

◆ getNumberedArguments()

PPTemplateFrame_DOM::getNumberedArguments ( )
Returns
array

Reimplemented from PPFrame_DOM.

Definition at line 1753 of file Preprocessor_DOM.php.

◆ isEmpty()

PPTemplateFrame_DOM::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns
bool

Reimplemented from PPFrame_DOM.

Definition at line 1739 of file Preprocessor_DOM.php.

◆ isTemplate()

PPTemplateFrame_DOM::isTemplate ( )

Return true if the frame is a template frame.

Returns
bool

Reimplemented from PPFrame_DOM.

Definition at line 1820 of file Preprocessor_DOM.php.

◆ setTTL()

PPTemplateFrame_DOM::setTTL (   $ttl)

Set the TTL.

Parameters
int$ttl

Reimplemented from PPFrame_DOM.

Definition at line 1829 of file Preprocessor_DOM.php.

◆ setVolatile()

PPTemplateFrame_DOM::setVolatile (   $flag = true)

Set the volatile flag.

Parameters
bool$flag

Reimplemented from PPFrame_DOM.

Definition at line 1824 of file Preprocessor_DOM.php.

Member Data Documentation

◆ $namedArgs

PPTemplateFrame_DOM::$namedArgs

Definition at line 1664 of file Preprocessor_DOM.php.

◆ $namedExpansionCache

PPTemplateFrame_DOM::$namedExpansionCache

Definition at line 1670 of file Preprocessor_DOM.php.

◆ $numberedArgs

PPTemplateFrame_DOM::$numberedArgs

Definition at line 1664 of file Preprocessor_DOM.php.

◆ $numberedExpansionCache

PPTemplateFrame_DOM::$numberedExpansionCache

Definition at line 1670 of file Preprocessor_DOM.php.

◆ $parent

PPFrame_DOM PPTemplateFrame_DOM::$parent

Definition at line 1669 of file Preprocessor_DOM.php.


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