MediaWiki master
MediaWiki\Parser\PPNode_Hash_Attr Class Reference

Inherits Stringable, and MediaWiki\Parser\PPNode.

Collaboration diagram for MediaWiki\Parser\PPNode_Hash_Attr:

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.

Returns
false|PPNode

 
 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

 
 getFirstChild ()
 Get the first child of a tree node.False if there isn't one.
Returns
false|PPNode

 
 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.

Returns
string

 
 getNextSibling ()
 Get the next sibling of any node.False if there isn't one

Returns
false|PPNode

 
 item ( $i)
 Returns an item of an array-type node.
Parameters
int$i
Returns
PPNode|false

 
 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}

 
 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}

 
 splitHeading ()
 Split an "<h>" node.
Returns
array{i:int,level:int}

 

Public Attributes

string $name
 
string $value
 

Detailed Description

Definition at line 18 of file PPNode_Hash_Attr.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Parser\PPNode_Hash_Attr::__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 36 of file PPNode_Hash_Attr.php.

References MediaWiki\Parser\PPNode_Hash_Tree\CHILDREN, and MediaWiki\Parser\PPNode_Hash_Tree\NAME.

Member Function Documentation

◆ __toString()

MediaWiki\Parser\PPNode_Hash_Attr::__toString ( )

Definition at line 47 of file PPNode_Hash_Attr.php.

◆ getChildren()

MediaWiki\Parser\PPNode_Hash_Attr::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 62 of file PPNode_Hash_Attr.php.

◆ getChildrenOfType()

MediaWiki\Parser\PPNode_Hash_Attr::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 72 of file PPNode_Hash_Attr.php.

◆ getFirstChild()

MediaWiki\Parser\PPNode_Hash_Attr::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 67 of file PPNode_Hash_Attr.php.

◆ getLength()

MediaWiki\Parser\PPNode_Hash_Attr::getLength ( )

Returns the length of the array, or false if this is not an array-type node.

Implements MediaWiki\Parser\PPNode.

Definition at line 77 of file PPNode_Hash_Attr.php.

◆ getName()

MediaWiki\Parser\PPNode_Hash_Attr::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 52 of file PPNode_Hash_Attr.php.

References MediaWiki\Parser\PPNode_Hash_Attr\$name.

◆ getNextSibling()

MediaWiki\Parser\PPNode_Hash_Attr::getNextSibling ( )

Get the next sibling of any node.False if there isn't one

Returns
false|PPNode

Implements MediaWiki\Parser\PPNode.

Definition at line 57 of file PPNode_Hash_Attr.php.

References MediaWiki\Parser\PPNode_Hash_Tree\factory().

◆ item()

MediaWiki\Parser\PPNode_Hash_Attr::item ( $i)

Returns an item of an array-type node.

Parameters
int$i
Returns
PPNode|false

Implements MediaWiki\Parser\PPNode.

Definition at line 82 of file PPNode_Hash_Attr.php.

◆ splitArg()

MediaWiki\Parser\PPNode_Hash_Attr::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 87 of file PPNode_Hash_Attr.php.

◆ splitExt()

MediaWiki\Parser\PPNode_Hash_Attr::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 93 of file PPNode_Hash_Attr.php.

◆ splitHeading()

MediaWiki\Parser\PPNode_Hash_Attr::splitHeading ( )

Split an "<h>" node.

Returns
array{i:int,level:int}

Implements MediaWiki\Parser\PPNode.

Definition at line 99 of file PPNode_Hash_Attr.php.

Member Data Documentation

◆ $name

string MediaWiki\Parser\PPNode_Hash_Attr::$name

Definition at line 21 of file PPNode_Hash_Attr.php.

Referenced by MediaWiki\Parser\PPNode_Hash_Attr\getName().

◆ $value

string MediaWiki\Parser\PPNode_Hash_Attr::$value

Definition at line 23 of file PPNode_Hash_Attr.php.


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