MediaWiki master
PPFrame.php
Go to the documentation of this file.
1<?php
23
30interface PPFrame {
31 public const NO_ARGS = 1;
32 public const NO_TEMPLATES = 2;
33 public const STRIP_COMMENTS = 4;
34 public const NO_IGNORE = 8;
35 public const RECOVER_COMMENTS = 16;
36 public const NO_TAGS = 32;
37 public const PROCESS_NOWIKI = 64;
38
39 public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
40 self::RECOVER_COMMENTS | self::NO_TAGS;
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}
Represents a title within MediaWiki.
Definition Title.php:78
isEmpty()
Returns true if there are no arguments in this frame.
getArguments()
Returns all arguments of this frame.
const NO_TEMPLATES
Definition PPFrame.php:32
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:36
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:39
const PROCESS_NOWIKI
Definition PPFrame.php:37
const RECOVER_COMMENTS
Definition PPFrame.php:35
const NO_ARGS
Definition PPFrame.php:31
const NO_IGNORE
Definition PPFrame.php:34
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:33
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.