MediaWiki  master
PPFrame.php
Go to the documentation of this file.
1 <?php
28 interface PPFrame {
29  public const NO_ARGS = 1;
30  public const NO_TEMPLATES = 2;
31  public const STRIP_COMMENTS = 4;
32  public const NO_IGNORE = 8;
33  public const RECOVER_COMMENTS = 16;
34  public const NO_TAGS = 32;
35  public const PROCESS_NOWIKI = 64;
36 
37  public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
38  self::RECOVER_COMMENTS | self::NO_TAGS;
39 
49  public function newChild( $args = false, $title = false, $indexOffset = 0 );
50 
58  public function cachedExpand( $key, $root, $flags = 0 );
59 
66  public function expand( $root, $flags = 0 );
67 
75  public function implodeWithFlags( $sep, $flags, ...$params );
76 
83  public function implode( $sep, ...$params );
84 
92  public function virtualImplode( $sep, ...$params );
93 
102  public function virtualBracketedImplode( $start, $sep, $end, ...$params );
103 
109  public function isEmpty();
110 
115  public function getArguments();
116 
121  public function getNumberedArguments();
122 
127  public function getNamedArguments();
128 
134  public function getArgument( $name );
135 
142  public function loopCheck( $title );
143 
148  public function isTemplate();
149 
161  public function setVolatile( $flag = true );
162 
172  public function isVolatile();
173 
186  public function getTTL();
187 
197  public function setTTL( $ttl );
198 
204  public function getTitle();
205 }
isEmpty()
Returns true if there are no arguments in this frame.
getArguments()
Returns all arguments of this frame.
const NO_TEMPLATES
Definition: PPFrame.php:30
getTTL()
Get the TTL of the frame's output.
getArgument( $name)
Get an argument to this frame by name.
cachedExpand( $key, $root, $flags=0)
Expand a document tree node, caching the result on its parent with the given key.
implode( $sep,... $params)
Implode with no flags specified.
const NO_TAGS
Definition: PPFrame.php:34
getNumberedArguments()
Returns all numbered arguments of this frame.
virtualBracketedImplode( $start, $sep, $end,... $params)
Virtual implode with brackets.
virtualImplode( $sep,... $params)
Makes an object that, when expand()ed, will be the same as one obtained with implode()
isVolatile()
Get the "volatile" flag.
const RECOVER_ORIG
Definition: PPFrame.php:37
const PROCESS_NOWIKI
Definition: PPFrame.php:35
const RECOVER_COMMENTS
Definition: PPFrame.php:33
const NO_ARGS
Definition: PPFrame.php:29
const NO_IGNORE
Definition: PPFrame.php:32
setTTL( $ttl)
Set the TTL of the output of this frame and all of its ancestors.
loopCheck( $title)
Returns true if the infinite loop check is OK, false if a loop is detected.
expand( $root, $flags=0)
Expand a document tree node.
isTemplate()
Return true if the frame is a template frame.
implodeWithFlags( $sep, $flags,... $params)
Implode with flags for expand()
const STRIP_COMMENTS
Definition: PPFrame.php:31
getTitle()
Get a title of frame.
getNamedArguments()
Returns all named arguments of this frame.
newChild( $args=false, $title=false, $indexOffset=0)
Create a child frame.
setVolatile( $flag=true)
Set the "volatile" flag.
if( $line===false) $args
Definition: mcc.php:124