MediaWiki  master
PPFrame.php
Go to the documentation of this file.
1 <?php
28 interface PPFrame {
29  const NO_ARGS = 1;
30  const NO_TEMPLATES = 2;
31  const STRIP_COMMENTS = 4;
32  const NO_IGNORE = 8;
33  const RECOVER_COMMENTS = 16;
34  const NO_TAGS = 32;
35 
36  const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
37  self::RECOVER_COMMENTS | self::NO_TAGS;
38 
41 
51  public function newChild( $args = false, $title = false, $indexOffset = 0 );
52 
60  public function cachedExpand( $key, $root, $flags = 0 );
61 
68  public function expand( $root, $flags = 0 );
69 
77  public function implodeWithFlags( $sep, $flags, ...$params );
78 
85  public function implode( $sep, ...$params );
86 
94  public function virtualImplode( $sep, ...$params );
95 
104  public function virtualBracketedImplode( $start, $sep, $end, ...$params );
105 
111  public function isEmpty();
112 
117  public function getArguments();
118 
123  public function getNumberedArguments();
124 
129  public function getNamedArguments();
130 
136  public function getArgument( $name );
137 
144  public function loopCheck( $title );
145 
150  public function isTemplate();
151 
163  public function setVolatile( $flag = true );
164 
174  public function isVolatile();
175 
188  public function getTTL();
189 
199  public function setTTL( $ttl );
200 
206  public function getTitle();
207 }
implodeWithFlags( $sep, $flags,... $params)
Implode with flags for expand()
setTTL( $ttl)
Set the TTL of the output of this frame and all of its ancestors.
isEmpty()
Returns true if there are no arguments in this frame.
getTTL()
Get the TTL of the frame&#39;s output.
getArguments()
Returns all arguments of this frame.
getNamedArguments()
Returns all named arguments of this frame.
const RECOVER_COMMENTS
Definition: PPFrame.php:33
getNumberedArguments()
Returns all numbered arguments of this frame.
const NO_ARGS
Definition: PPFrame.php:29
newChild( $args=false, $title=false, $indexOffset=0)
Create a child frame.
virtualImplode( $sep,... $params)
Makes an object that, when expand()ed, will be the same as one obtained with implode() ...
const NO_IGNORE
Definition: PPFrame.php:32
setVolatile( $flag=true)
Set the "volatile" flag.
if( $line===false) $args
Definition: mcc.php:124
const NO_TEMPLATES
Definition: PPFrame.php:30
implode( $sep,... $params)
Implode with no flags specified.
const RECOVER_ORIG
Definition: PPFrame.php:36
isVolatile()
Get the "volatile" flag.
getTitle()
Get a title of frame.
getArgument( $name)
Get an argument to this frame by name.
expand( $root, $flags=0)
Expand a document tree node.
const NO_TAGS
Definition: PPFrame.php:34
cachedExpand( $key, $root, $flags=0)
Expand a document tree node, caching the result on its parent with the given key. ...
const STRIP_COMMENTS
Definition: PPFrame.php:31
isTemplate()
Return true if the frame is a template frame.
const SUPPORTS_INDEX_OFFSET
This constant exists when $indexOffset is supported in newChild()
Definition: PPFrame.php:40
virtualBracketedImplode( $start, $sep, $end,... $params)
Virtual implode with brackets.
loopCheck( $title)
Returns true if the infinite loop check is OK, false if a loop is detected.