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 
36  public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
37  self::RECOVER_COMMENTS | self::NO_TAGS;
38 
48  public function newChild( $args = false, $title = false, $indexOffset = 0 );
49 
57  public function cachedExpand( $key, $root, $flags = 0 );
58 
65  public function expand( $root, $flags = 0 );
66 
74  public function implodeWithFlags( $sep, $flags, ...$params );
75 
82  public function implode( $sep, ...$params );
83 
91  public function virtualImplode( $sep, ...$params );
92 
101  public function virtualBracketedImplode( $start, $sep, $end, ...$params );
102 
108  public function isEmpty();
109 
114  public function getArguments();
115 
120  public function getNumberedArguments();
121 
126  public function getNamedArguments();
127 
133  public function getArgument( $name );
134 
141  public function loopCheck( $title );
142 
147  public function isTemplate();
148 
160  public function setVolatile( $flag = true );
161 
171  public function isVolatile();
172 
185  public function getTTL();
186 
196  public function setTTL( $ttl );
197 
203  public function getTitle();
204 }
PPFrame\isEmpty
isEmpty()
Returns true if there are no arguments in this frame.
PPFrame\getArguments
getArguments()
Returns all arguments of this frame.
PPFrame\loopCheck
loopCheck( $title)
Returns true if the infinite loop check is OK, false if a loop is detected.
PPFrame\setTTL
setTTL( $ttl)
Set the TTL of the output of this frame and all of its ancestors.
PPFrame\getNamedArguments
getNamedArguments()
Returns all named arguments of this frame.
PPFrame\STRIP_COMMENTS
const STRIP_COMMENTS
Definition: PPFrame.php:31
PPFrame\NO_ARGS
const NO_ARGS
Definition: PPFrame.php:29
PPFrame\implodeWithFlags
implodeWithFlags( $sep, $flags,... $params)
Implode with flags for expand()
PPFrame\virtualImplode
virtualImplode( $sep,... $params)
Makes an object that, when expand()ed, will be the same as one obtained with implode()
PPFrame\NO_IGNORE
const NO_IGNORE
Definition: PPFrame.php:32
PPFrame\getNumberedArguments
getNumberedArguments()
Returns all numbered arguments of this frame.
PPFrame\implode
implode( $sep,... $params)
Implode with no flags specified.
PPFrame\RECOVER_COMMENTS
const RECOVER_COMMENTS
Definition: PPFrame.php:33
PPFrame\NO_TEMPLATES
const NO_TEMPLATES
Definition: PPFrame.php:30
PPFrame\newChild
newChild( $args=false, $title=false, $indexOffset=0)
Create a child frame.
PPFrame\setVolatile
setVolatile( $flag=true)
Set the "volatile" flag.
PPFrame\getTitle
getTitle()
Get a title of frame.
PPFrame\RECOVER_ORIG
const RECOVER_ORIG
Definition: PPFrame.php:36
$args
if( $line===false) $args
Definition: mcc.php:124
$title
$title
Definition: testCompression.php:38
PPFrame\expand
expand( $root, $flags=0)
Expand a document tree node.
PPFrame\NO_TAGS
const NO_TAGS
Definition: PPFrame.php:34
PPFrame
Definition: PPFrame.php:28
PPFrame\isVolatile
isVolatile()
Get the "volatile" flag.
PPFrame\cachedExpand
cachedExpand( $key, $root, $flags=0)
Expand a document tree node, caching the result on its parent with the given key.
PPFrame\virtualBracketedImplode
virtualBracketedImplode( $start, $sep, $end,... $params)
Virtual implode with brackets.
PPFrame\getArgument
getArgument( $name)
Get an argument to this frame by name.
PPFrame\isTemplate
isTemplate()
Return true if the frame is a template frame.
PPFrame\getTTL
getTTL()
Get the TTL of the frame's output.