6 interface Preprocessor
{
7 /** Create a new preprocessor object based on an initialised Parser object */
8 function __construct( $parser );
10 /** Create a new top-level frame for expansion of a page */
13 /** Preprocess text to a PPNode */
14 function preprocessToObj( $text, $flags = 0 );
22 const NO_TEMPLATES
= 2;
23 const STRIP_COMMENTS
= 4;
25 const RECOVER_COMMENTS
= 16;
27 const RECOVER_ORIG
= 27; // = 1|2|8|16 no constant expression support in PHP yet
30 * Create a child frame
32 function newChild( $args = false, $title = false );
35 * Expand a document tree node
37 function expand( $root, $flags = 0 );
40 * Implode with flags for expand()
42 function implodeWithFlags( $sep, $flags /*, ... */ );
45 * Implode with no flags specified
47 function implode( $sep /*, ... */ );
50 * Makes an object that, when expand()ed, will be the same as one obtained
53 function virtualImplode( $sep /*, ... */ );
56 * Virtual implode with brackets
58 function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
61 * Returns true if there are no arguments in this frame
66 * Get an argument to this frame by name
68 function getArgument( $name );
71 * Returns true if the infinite loop check is OK, false if a loop is detected
73 function loopCheck( $title );
76 * Return true if the frame is a template frame
78 function isTemplate();
82 * There are three types of nodes:
83 * * Tree nodes, which have a name and contain other nodes as children
84 * * Array nodes, which also contain other nodes but aren't considered part of a tree
85 * * Leaf nodes, which contain the actual data
87 * This interface provides access to the tree structure and to the contents of array nodes,
88 * but it does not provide access to the internal structure of leaf nodes. Access to leaf
89 * data is provided via two means:
90 * * PPFrame::expand(), which provides expanded text
91 * * The PPNode::split*() functions, which provide metadata about certain types of tree node
96 * Get an array-type node containing the children of this node.
97 * Returns false if this is not a tree node.
99 function getChildren();
102 * Get the first child of a tree node. False if there isn't one.
104 function getFirstChild();
107 * Get the next sibling of any node. False if there isn't one
109 function getNextSibling();
112 * Get all children of this tree node which have a given name.
113 * Returns an array-type node, or false if this is not a tree node.
115 function getChildrenOfType( $type );
119 * Returns the length of the array, or false if this is not an array-type node
121 function getLength();
124 * Returns an item of an array-type node
129 * Get the name of this node. The following names are defined here:
132 * template A double-brace node.
133 * tplarg A triple-brace node.
134 * title The first argument to a template or tplarg node.
135 * part Subsequent arguments to a template or tplarg node.
136 * #nodelist An array-type node
138 * The subclass may define various other names for tree and leaf nodes.
143 * Split a <part> node into an associative array containing:
151 * Split an <ext> node into an associative array containing name, attr, inner and close
152 * All values in the resulting array are PPNodes. Inner and close are optional.
159 function splitHeading();