MediaWiki  REL1_31
PPNode Interface Reference

There are three types of nodes: More...

Inheritance diagram for PPNode:

Public Member Functions

 getChildren ()
 Get an array-type node containing the children of this node. More...
 
 getChildrenOfType ( $type)
 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...
 

Detailed Description

There are three types of nodes:

  • Tree nodes, which have a name and contain other nodes as children
  • Array nodes, which also contain other nodes but aren't considered part of a tree
  • Leaf nodes, which contain the actual data

This interface provides access to the tree structure and to the contents of array nodes, but it does not provide access to the internal structure of leaf nodes. Access to leaf data is provided via two means:

  • PPFrame::expand(), which provides expanded text
  • The PPNode::split*() functions, which provide metadata about certain types of tree node

Definition at line 359 of file Preprocessor.php.

Member Function Documentation

◆ getChildren()

PPNode::getChildren ( )

Get an array-type node containing the children of this node.

Returns false if this is not a tree node.

Returns
PPNode

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ getChildrenOfType()

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

Implemented in PPNode_DOM, PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, and PPNode_Hash_Tree.

◆ getFirstChild()

PPNode::getFirstChild ( )

Get the first child of a tree node.

False if there isn't one.

Returns
PPNode

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ getLength()

PPNode::getLength ( )

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

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ getName()

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

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ getNextSibling()

PPNode::getNextSibling ( )

Get the next sibling of any node.

False if there isn't one

Returns
PPNode

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ item()

PPNode::item (   $i)

Returns an item of an array-type node.

Parameters
int$i
Returns
bool|PPNode

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ splitArg()

PPNode::splitArg ( )

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

Returns
array

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ splitExt()

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

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.

◆ splitHeading()

PPNode::splitHeading ( )

Split an "<h>" node.

Returns
array

Implemented in PPNode_Hash_Attr, PPNode_Hash_Array, PPNode_Hash_Text, PPNode_Hash_Tree, and PPNode_DOM.


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