Inherits Stringable, and MediaWiki\Parser\PPNode.
Public Member Functions | ||||
| __construct (array $store, $index) | ||||
| Construct an object using the data from $store[$index]. | ||||
| __toString () | ||||
| getChildren () | ||||
Get an array-type node containing the children of this node.Returns false if this is not a tree node.
| ||||
| getChildrenOfType ( $name) | ||||
Get all children of this tree node which have a given name.Returns an array-type node, or false if this is not a tree node.
| ||||
| getFirstChild () | ||||
Get the first child of a tree node.False if there isn't one.
| ||||
| getLength () | ||||
| Returns the length of the array, or false if this is not an array-type node. | ||||
| getName () | ||||
Get the name of this node.The following names are defined here:h A heading node. template A double-brace node. tplarg A triple-brace node. title The first argument to a template or tplarg node. part Subsequent arguments to a template or tplarg node. #nodelist An array-type nodeThe subclass may define various other names for tree and leaf nodes.
| ||||
| getNextSibling () | ||||
Get the next sibling of any node.False if there isn't one
| ||||
| item ( $i) | ||||
Returns an item of an array-type node.
| ||||
| splitArg () | ||||
Split a "<part>" node into an associative array containing: name PPNode name index String index value PPNode value.
| ||||
| splitExt () | ||||
Split an "<ext>" node into an associative array containing name, attr, inner and close All values in the resulting array are PPNodes.Inner and close are optional.
| ||||
| splitHeading () | ||||
Split an "<h>" node.
| ||||
Public Attributes | |
| string | $value |
Detailed Description
Definition at line 18 of file PPNode_Hash_Text.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Parser\PPNode_Hash_Text::__construct | ( | array | $store, |
| $index ) |
Construct an object using the data from $store[$index].
The rest of the store array can be accessed via getNextSibling().
- Parameters
-
array $store int $index
Definition at line 34 of file PPNode_Hash_Text.php.
Member Function Documentation
◆ __toString()
| MediaWiki\Parser\PPNode_Hash_Text::__toString | ( | ) |
Definition at line 43 of file PPNode_Hash_Text.php.
◆ getChildren()
| MediaWiki\Parser\PPNode_Hash_Text::getChildren | ( | ) |
Get an array-type node containing the children of this node.Returns false if this is not a tree node.
- Returns
- false|PPNode
Implements MediaWiki\Parser\PPNode.
Definition at line 53 of file PPNode_Hash_Text.php.
◆ getChildrenOfType()
| MediaWiki\Parser\PPNode_Hash_Text::getChildrenOfType | ( | $name | ) |
Get all children of this tree node which have a given name.Returns an array-type node, or false if this is not a tree node.
- Parameters
-
string $type
- Returns
- false|PPNode
Implements MediaWiki\Parser\PPNode.
Definition at line 63 of file PPNode_Hash_Text.php.
◆ getFirstChild()
| MediaWiki\Parser\PPNode_Hash_Text::getFirstChild | ( | ) |
Get the first child of a tree node.False if there isn't one.
- Returns
- false|PPNode
Implements MediaWiki\Parser\PPNode.
Definition at line 58 of file PPNode_Hash_Text.php.
◆ getLength()
| MediaWiki\Parser\PPNode_Hash_Text::getLength | ( | ) |
Returns the length of the array, or false if this is not an array-type node.
Implements MediaWiki\Parser\PPNode.
Definition at line 68 of file PPNode_Hash_Text.php.
◆ getName()
| MediaWiki\Parser\PPNode_Hash_Text::getName | ( | ) |
Get the name of this node.The following names are defined here:h A heading node. template A double-brace node. tplarg A triple-brace node. title The first argument to a template or tplarg node. part Subsequent arguments to a template or tplarg node. #nodelist An array-type nodeThe subclass may define various other names for tree and leaf nodes.
- Returns
- string
Implements MediaWiki\Parser\PPNode.
Definition at line 78 of file PPNode_Hash_Text.php.
◆ getNextSibling()
| MediaWiki\Parser\PPNode_Hash_Text::getNextSibling | ( | ) |
Get the next sibling of any node.False if there isn't one
- Returns
- false|PPNode
Implements MediaWiki\Parser\PPNode.
Definition at line 48 of file PPNode_Hash_Text.php.
References MediaWiki\Parser\PPNode_Hash_Tree\factory().
◆ item()
| MediaWiki\Parser\PPNode_Hash_Text::item | ( | $i | ) |
Returns an item of an array-type node.
- Parameters
-
int $i
- Returns
- PPNode|false
Implements MediaWiki\Parser\PPNode.
Definition at line 73 of file PPNode_Hash_Text.php.
◆ splitArg()
| MediaWiki\Parser\PPNode_Hash_Text::splitArg | ( | ) |
Split a "<part>" node into an associative array containing: name PPNode name index String index value PPNode value.
- Returns
- array{name:self,index:string|int,value:self}
Implements MediaWiki\Parser\PPNode.
Definition at line 83 of file PPNode_Hash_Text.php.
◆ splitExt()
| MediaWiki\Parser\PPNode_Hash_Text::splitExt | ( | ) |
Split an "<ext>" node into an associative array containing name, attr, inner and close All values in the resulting array are PPNodes.Inner and close are optional.
- Returns
- array{name:self,attr?:self,inner?:self,close?:self}
Implements MediaWiki\Parser\PPNode.
Definition at line 89 of file PPNode_Hash_Text.php.
◆ splitHeading()
| MediaWiki\Parser\PPNode_Hash_Text::splitHeading | ( | ) |
Split an "<h>" node.
- Returns
- array{i:int,level:int}
Implements MediaWiki\Parser\PPNode.
Definition at line 95 of file PPNode_Hash_Text.php.
Member Data Documentation
◆ $value
| string MediaWiki\Parser\PPNode_Hash_Text::$value |
Definition at line 21 of file PPNode_Hash_Text.php.
The documentation for this class was generated from the following file:
- includes/Parser/PPNode_Hash_Text.php
