MediaWiki master
Public Member Functions | Public Attributes | List of all members
MediaWiki\Parser\PPNode_Hash_Attr Class Reference
Parser

Inherits Stringable, and MediaWiki\Parser\PPNode.

Collaboration diagram for MediaWiki\Parser\PPNode_Hash_Attr:
Collaboration graph
[legend]

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.
 
 getChildrenOfType ( $name)
 Get all children of this tree node which have a given name.
 
 getFirstChild ()
 Get the first child of a tree node.
 
 getLength ()
 Returns the length of the array, or false if this is not an array-type node.
 
 getName ()
 Get the name of this node.
 
 getNextSibling ()
 Get the next sibling of any node.
 
 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.
 
 splitHeading ()
 Split an "<h>" node.
 

Public Attributes

string $name
 
string $value
 

Detailed Description

Definition at line 32 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 50 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 61 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 73 of file PPNode_Hash_Attr.php.

◆ getChildrenOfType()

MediaWiki\Parser\PPNode_Hash_Attr::getChildrenOfType ( $type)

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 81 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 77 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 85 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 node

The subclass may define various other names for tree and leaf nodes.

Returns
string

Implements MediaWiki\Parser\PPNode.

Definition at line 65 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 69 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 89 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

Implements MediaWiki\Parser\PPNode.

Definition at line 93 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

Implements MediaWiki\Parser\PPNode.

Definition at line 98 of file PPNode_Hash_Attr.php.

◆ splitHeading()

MediaWiki\Parser\PPNode_Hash_Attr::splitHeading ( )

Split an "<h>" node.

Returns
array

Implements MediaWiki\Parser\PPNode.

Definition at line 103 of file PPNode_Hash_Attr.php.

Member Data Documentation

◆ $name

string MediaWiki\Parser\PPNode_Hash_Attr::$name

Definition at line 35 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 37 of file PPNode_Hash_Attr.php.

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