MediaWiki master
PPNode_Hash_Array Class Reference

Inherits PPNode.

Collaboration diagram for PPNode_Hash_Array:

Public Member Functions

 __construct ( $value)
 
 __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

array $value
 

Detailed Description

Definition at line 26 of file PPNode_Hash_Array.php.

Constructor & Destructor Documentation

◆ __construct()

PPNode_Hash_Array::__construct (   $value)
Parameters
array$value

Definition at line 34 of file PPNode_Hash_Array.php.

References $value.

Member Function Documentation

◆ __toString()

PPNode_Hash_Array::__toString ( )

Definition at line 38 of file PPNode_Hash_Array.php.

◆ getChildren()

PPNode_Hash_Array::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 PPNode.

Definition at line 58 of file PPNode_Hash_Array.php.

◆ getChildrenOfType()

PPNode_Hash_Array::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 PPNode.

Definition at line 66 of file PPNode_Hash_Array.php.

◆ getFirstChild()

PPNode_Hash_Array::getFirstChild ( )

Get the first child of a tree node.

False if there isn't one.

Returns
false|PPNode

Implements PPNode.

Definition at line 62 of file PPNode_Hash_Array.php.

◆ getLength()

PPNode_Hash_Array::getLength ( )

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

Implements PPNode.

Definition at line 42 of file PPNode_Hash_Array.php.

◆ getName()

PPNode_Hash_Array::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 PPNode.

Definition at line 50 of file PPNode_Hash_Array.php.

◆ getNextSibling()

PPNode_Hash_Array::getNextSibling ( )

Get the next sibling of any node.

False if there isn't one

Returns
false|PPNode

Implements PPNode.

Definition at line 54 of file PPNode_Hash_Array.php.

◆ item()

PPNode_Hash_Array::item (   $i)

Returns an item of an array-type node.

Parameters
int$i
Returns
PPNode|false

Implements PPNode.

Definition at line 46 of file PPNode_Hash_Array.php.

◆ splitArg()

PPNode_Hash_Array::splitArg ( )

Split a "<part>" node into an associative array containing: name PPNode name index String index value PPNode value.

Returns
array

Implements PPNode.

Definition at line 70 of file PPNode_Hash_Array.php.

◆ splitExt()

PPNode_Hash_Array::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 PPNode.

Definition at line 75 of file PPNode_Hash_Array.php.

◆ splitHeading()

PPNode_Hash_Array::splitHeading ( )

Split an "<h>" node.

Returns
array

Implements PPNode.

Definition at line 80 of file PPNode_Hash_Array.php.

Member Data Documentation

◆ $value

array PPNode_Hash_Array::$value

Definition at line 29 of file PPNode_Hash_Array.php.

Referenced by __construct().


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