3 interface Preprocessor
{
4 /** Create a new preprocessor object based on an initialised Parser object */
5 function __construct( $parser );
7 /** Create a new top-level frame for expansion of a page */
10 /** Preprocess text to a PPNode */
11 function preprocessToObj( $text, $flags = 0 );
16 const NO_TEMPLATES
= 2;
17 const STRIP_COMMENTS
= 4;
19 const RECOVER_COMMENTS
= 16;
21 const RECOVER_ORIG
= 27; // = 1|2|8|16 no constant expression support in PHP yet
24 * Create a child frame
26 function newChild( $args = false, $title = false );
29 * Expand a document tree node
31 function expand( $root, $flags = 0 );
34 * Implode with flags for expand()
36 function implodeWithFlags( $sep, $flags /*, ... */ );
39 * Implode with no flags specified
41 function implode( $sep /*, ... */ );
44 * Makes an object that, when expand()ed, will be the same as one obtained
47 function virtualImplode( $sep /*, ... */ );
50 * Virtual implode with brackets
52 function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
55 * Returns true if there are no arguments in this frame
60 * Get an argument to this frame by name
62 function getArgument( $name );
65 * Returns true if the infinite loop check is OK, false if a loop is detected
67 function loopCheck( $title );
70 * Return true if the frame is a template frame
72 function isTemplate();
76 * There are three types of nodes:
77 * * Tree nodes, which have a name and contain other nodes as children
78 * * Array nodes, which also contain other nodes but aren't considered part of a tree
79 * * Leaf nodes, which contain the actual data
81 * This interface provides access to the tree structure and to the contents of array nodes,
82 * but it does not provide access to the internal structure of leaf nodes. Access to leaf
83 * data is provided via two means:
84 * * PPFrame::expand(), which provides expanded text
85 * * The PPNode::split*() functions, which provide metadata about certain types of tree node
89 * Get an array-type node containing the children of this node.
90 * Returns false if this is not a tree node.
92 function getChildren();
95 * Get the first child of a tree node. False if there isn't one.
97 function getFirstChild();
100 * Get the next sibling of any node. False if there isn't one
102 function getNextSibling();
105 * Get all children of this tree node which have a given name.
106 * Returns an array-type node, or false if this is not a tree node.
108 function getChildrenOfType( $type );
112 * Returns the length of the array, or false if this is not an array-type node
114 function getLength();
117 * Returns an item of an array-type node
122 * Get the name of this node. The following names are defined here:
125 * template A double-brace node.
126 * tplarg A triple-brace node.
127 * title The first argument to a template or tplarg node.
128 * part Subsequent arguments to a template or tplarg node.
129 * #nodelist An array-type node
131 * The subclass may define various other names for tree and leaf nodes.
136 * Split a <part> node into an associative array containing:
144 * Split an <ext> node into an associative array containing name, attr, inner and close
145 * All values in the resulting array are PPNodes. Inner and close are optional.
152 function splitHeading();