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 () | |
| isEmpty () | |
 Public Member Functions inherited from PPFrame_Hash | |
| __construct ( $preprocessor) | |
| Construct a new preprocessor frame. | |
| cachedExpand ( $key, $root, $flags=0) | |
| expand ( $root, $flags=0) | |
| getNamedArguments () | |
| getNumberedArguments () | |
| getPDBK ( $level=false) | |
| getTitle () | |
| Get a title of frame. | |
| getTTL () | |
| Get the TTL. | |
| 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) | |
| Set the 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 | |
| $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() | |
| $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 |
| $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 |
| const | SUPPORTS_INDEX_OFFSET = 1 |
| This constant exists when $indexOffset is supported in newChild() | |
Additional Inherited Members | |
| Protected Attributes inherited from PPFrame_Hash | |
| array | $childExpansionCache |
Detailed Description
Expansion frame with custom arguments.
Definition at line 27 of file PPCustomFrame_Hash.php.
Constructor & Destructor Documentation
◆ __construct()
| PPCustomFrame_Hash::__construct | ( | $preprocessor, | |
| $args | |||
| ) |
Definition at line 31 of file PPCustomFrame_Hash.php.
References $args, and PPFrame_Hash\$preprocessor.
Member Function Documentation
◆ __toString()
| PPCustomFrame_Hash::__toString | ( | ) |
Reimplemented from PPFrame_Hash.
Definition at line 36 of file PPCustomFrame_Hash.php.
References $s.
◆ getArgument()
| PPCustomFrame_Hash::getArgument | ( | $index | ) |
- Parameters
-
int | string $index
- Returns
- string|bool
Reimplemented from PPFrame_Hash.
Definition at line 63 of file PPCustomFrame_Hash.php.
◆ getArguments()
| PPCustomFrame_Hash::getArguments | ( | ) |
- Returns
- array
Reimplemented from PPFrame_Hash.
Definition at line 67 of file PPCustomFrame_Hash.php.
References $args.
◆ isEmpty()
| PPCustomFrame_Hash::isEmpty | ( | ) |
Member Data Documentation
◆ $args
| PPCustomFrame_Hash::$args |
Definition at line 29 of file PPCustomFrame_Hash.php.
Referenced by __construct(), and getArguments().
The documentation for this class was generated from the following file:
- includes/parser/PPCustomFrame_Hash.php
