MediaWiki  REL1_24
Preprocessor.php
Go to the documentation of this file.
00001 <?php
00027 interface Preprocessor {
00033     public function __construct( $parser );
00034 
00040     public function newFrame();
00041 
00050     public function newCustomFrame( $args );
00051 
00058     public function newPartNodeArray( $values );
00059 
00068     public function preprocessToObj( $text, $flags = 0 );
00069 }
00070 
00074 interface PPFrame {
00075     const NO_ARGS = 1;
00076     const NO_TEMPLATES = 2;
00077     const STRIP_COMMENTS = 4;
00078     const NO_IGNORE = 8;
00079     const RECOVER_COMMENTS = 16;
00080     const NO_TAGS = 32;
00081 
00082     const RECOVER_ORIG = 59; // = 1|2|8|16|32 no constant expression support in PHP yet
00083 
00085     const SUPPORTS_INDEX_OFFSET = 1;
00086 
00096     public function newChild( $args = false, $title = false, $indexOffset = 0 );
00097 
00105     public function cachedExpand( $key, $root, $flags = 0 );
00106 
00113     public function expand( $root, $flags = 0 );
00114 
00122     public function implodeWithFlags( $sep, $flags /*, ... */ );
00123 
00130     public function implode( $sep /*, ... */ );
00131 
00139     public function virtualImplode( $sep /*, ... */ );
00140 
00149     public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
00150 
00156     public function isEmpty();
00157 
00162     public function getArguments();
00163 
00168     public function getNumberedArguments();
00169 
00174     public function getNamedArguments();
00175 
00181     public function getArgument( $name );
00182 
00189     public function loopCheck( $title );
00190 
00195     public function isTemplate();
00196 
00208     public function setVolatile( $flag = true );
00209 
00219     public function isVolatile();
00220 
00233     public function getTTL();
00234 
00244     public function setTTL( $ttl );
00245 
00251     public function getTitle();
00252 }
00253 
00267 interface PPNode {
00273     public function getChildren();
00274 
00280     public function getFirstChild();
00281 
00286     public function getNextSibling();
00287 
00294     public function getChildrenOfType( $type );
00295 
00299     public function getLength();
00300 
00306     public function item( $i );
00307 
00321     public function getName();
00322 
00330     public function splitArg();
00331 
00337     public function splitExt();
00338 
00343     public function splitHeading();
00344 }