PPNode_Hash_Text Class Reference

Inheritance diagram for PPNode_Hash_Text:

Collaboration diagram for PPNode_Hash_Text:

Public Member Functions
	__construct (array $store, $index)
	Construct an object using the data from $store[$index]. More...
	__toString ()
	getChildren ()
	Get an array-type node containing the children of this node. More...
	getChildrenOfType ( $name)
	Get all children of this tree node which have a given name. More...
	getFirstChild ()
	Get the first child of a tree node. More...
	getLength ()
	Returns the length of the array, or false if this is not an array-type node. More...
	getName ()
	Get the name of this node. More...
	getNextSibling ()
	Get the next sibling of any node. More...
	item ( $i)
	Returns an item of an array-type node. More...
	splitArg ()
	Split a "<part>" node into an associative array containing: name PPNode name index String index value PPNode value. More...
	splitExt ()
	Split an "<ext>" node into an associative array containing name, attr, inner and close All values in the resulting array are PPNodes. More...
	splitHeading ()
	Split an "<h>" node. More...

Public Attributes
	$index
	$value

Private Attributes
	$store

Detailed Description

Definition at line 2027 of file Preprocessor_Hash.php.

Constructor & Destructor Documentation

__construct()

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 2040 of file Preprocessor_Hash.php.

References store, and value.

Member Function Documentation

__toString()

PPNode_Hash_Text::__toString

(

)

Definition at line 2049 of file Preprocessor_Hash.php.

References value.

getChildren()

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

PPNode

Implements PPNode.

Definition at line 2057 of file Preprocessor_Hash.php.

getChildrenOfType()

PPNode_Hash_Text::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

bool|PPNode

Implements PPNode.

Definition at line 2065 of file Preprocessor_Hash.php.

getFirstChild()

PPNode_Hash_Text::getFirstChild

(

)

Get the first child of a tree node.

False if there isn't one.

Returns

PPNode

Implements PPNode.

Definition at line 2061 of file Preprocessor_Hash.php.

getLength()

PPNode_Hash_Text::getLength

(

)

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

Implements PPNode.

Definition at line 2069 of file Preprocessor_Hash.php.

getName()

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 node

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

Returns

string

Implements PPNode.

Definition at line 2077 of file Preprocessor_Hash.php.

getNextSibling()

PPNode_Hash_Text::getNextSibling

(

)

Get the next sibling of any node.

False if there isn't one

Returns

PPNode

Implements PPNode.

Definition at line 2053 of file Preprocessor_Hash.php.

References PPNode_Hash_Tree\factory(), and store.

item()

PPNode_Hash_Text::item

(

$i

)

Returns an item of an array-type node.

Parameters

int

$i

Returns

bool|PPNode

Implements PPNode.

Definition at line 2073 of file Preprocessor_Hash.php.

splitArg()

PPNode_Hash_Text::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 2081 of file Preprocessor_Hash.php.

splitExt()

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

Implements PPNode.

Definition at line 2085 of file Preprocessor_Hash.php.

splitHeading()

PPNode_Hash_Text::splitHeading

(

)

Split an "<h>" node.

Returns

array

Implements PPNode.

Definition at line 2089 of file Preprocessor_Hash.php.

Member Data Documentation

$index

PPNode_Hash_Text::$index

Definition at line 2031 of file Preprocessor_Hash.php.

$store

PPNode_Hash_Text::$store

private

Definition at line 2031 of file Preprocessor_Hash.php.

$value

PPNode_Hash_Text::$value

Definition at line 2030 of file Preprocessor_Hash.php.

---

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

• includes/parser/Preprocessor_Hash.php