MediaWiki REL1_35
PPFrame.php
Go to the documentation of this file.
1<?php
28interface 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}
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:36
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