PPNode_Hash_Attr Class Reference

Inheritance diagram for PPNode_Hash_Attr:

Collaboration diagram for 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.
	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 26 of file PPNode_Hash_Attr.php.

Constructor & Destructor Documentation

__construct()

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 44 of file PPNode_Hash_Attr.php.

References PPNode_Hash_Tree\CHILDREN, and PPNode_Hash_Tree\NAME.

Member Function Documentation

__toString()

PPNode_Hash_Attr::__toString

(

)

Definition at line 55 of file PPNode_Hash_Attr.php.

getChildren()

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

Definition at line 67 of file PPNode_Hash_Attr.php.

getChildrenOfType()

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

Definition at line 75 of file PPNode_Hash_Attr.php.

getFirstChild()

PPNode_Hash_Attr::getFirstChild

(

)

Get the first child of a tree node.

False if there isn't one.

Returns

false|PPNode

Implements PPNode.

Definition at line 71 of file PPNode_Hash_Attr.php.

getLength()

PPNode_Hash_Attr::getLength

(

)

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

Implements PPNode.

Definition at line 79 of file PPNode_Hash_Attr.php.

getName()

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

Definition at line 59 of file PPNode_Hash_Attr.php.

References $name.

getNextSibling()

PPNode_Hash_Attr::getNextSibling

(

)

Get the next sibling of any node.

False if there isn't one

Returns

false|PPNode

Implements PPNode.

Definition at line 63 of file PPNode_Hash_Attr.php.

References PPNode_Hash_Tree\factory().

item()

PPNode_Hash_Attr::item

(

$i

)

Returns an item of an array-type node.

Parameters

int

$i

Returns

bool|PPNode

Implements PPNode.

Definition at line 83 of file PPNode_Hash_Attr.php.

splitArg()

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

Definition at line 87 of file PPNode_Hash_Attr.php.

splitExt()

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

Definition at line 92 of file PPNode_Hash_Attr.php.

splitHeading()

PPNode_Hash_Attr::splitHeading

(

)

Split an "<h>" node.

Returns

array

Implements PPNode.

Definition at line 97 of file PPNode_Hash_Attr.php.

Member Data Documentation

$name

string PPNode_Hash_Attr::$name

Definition at line 29 of file PPNode_Hash_Attr.php.

Referenced by getName().

$value

string PPNode_Hash_Attr::$value

Definition at line 31 of file PPNode_Hash_Attr.php.

---

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

• includes/parser/PPNode_Hash_Attr.php