PPCustomFrame_Hash Class Reference
Expansion frame with custom arguments. More...
Inheritance diagram for PPCustomFrame_Hash:
Collaboration diagram for PPCustomFrame_Hash:
Public Member Functions | |
| __construct ($preprocessor, $args) | |
| __toString () | |
| getArgument ($index) | |
| getArguments () | |
| Returns all arguments of this frame. More... | |
| isEmpty () | |
 Public Member Functions inherited from PPFrame_Hash | |
| __construct ($preprocessor) | |
| Construct a new preprocessor frame. More... | |
| __toString () | |
| cachedExpand ($key, $root, $flags=0) | |
| expand ($root, $flags=0) | |
| getArgument ($name) | |
| getArguments () | |
| getNamedArguments () | |
| getNumberedArguments () | |
| 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) | |
| isEmpty () | |
| Returns true if there are no arguments in this frame. More... | |
| isTemplate () | |
| Return true if the frame is a template frame. More... | |
| 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... | |
| setTTL ($ttl) | |
| Set the TTL. More... | |
| setVolatile ($flag=true) | |
| Set the volatile flag. 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 | |
| $args | |
| 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 = 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_Hash | |
| array | $childExpansionCache |
Detailed Description
Expansion frame with custom arguments.
Definition at line 1636 of file Preprocessor_Hash.php.
Constructor & Destructor Documentation
| PPCustomFrame_Hash::__construct | ( | $preprocessor, | |
| $args | |||
| ) |
Definition at line 1641 of file Preprocessor_Hash.php.
References $args, and PPFrame_Hash\$preprocessor.
Member Function Documentation
| PPCustomFrame_Hash::__toString | ( | ) |
| PPCustomFrame_Hash::getArgument | ( | $index | ) |
- Parameters
-
int | string $index
- Returns
- string|bool
Implements PPFrame.
Definition at line 1673 of file Preprocessor_Hash.php.
| PPCustomFrame_Hash::getArguments | ( | ) |
Returns all arguments of this frame.
- Returns
- array
Implements PPFrame.
Definition at line 1680 of file Preprocessor_Hash.php.
References $args.
| PPCustomFrame_Hash::isEmpty | ( | ) |
Member Data Documentation
| PPCustomFrame_Hash::$args |
Definition at line 1639 of file Preprocessor_Hash.php.
Referenced by __construct(), and getArguments().
The documentation for this class was generated from the following file:
- includes/parser/Preprocessor_Hash.php
