MediaWiki master
PPFrame.php
Go to the documentation of this file.
1<?php
22namespace MediaWiki\Parser;
23
25
32interface PPFrame {
33 public const NO_ARGS = 1;
34 public const NO_TEMPLATES = 2;
35 public const STRIP_COMMENTS = 4;
36 public const NO_IGNORE = 8;
37 public const RECOVER_COMMENTS = 16;
38 public const NO_TAGS = 32;
39 public const PROCESS_NOWIKI = 64;
40
41 public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
42 self::RECOVER_COMMENTS | self::NO_TAGS;
43
53 public function newChild( $args = false, $title = false, $indexOffset = 0 );
54
62 public function cachedExpand( $key, $root, $flags = 0 );
63
70 public function expand( $root, $flags = 0 );
71
79 public function implodeWithFlags( $sep, $flags, ...$params );
80
87 public function implode( $sep, ...$params );
88
96 public function virtualImplode( $sep, ...$params );
97
106 public function virtualBracketedImplode( $start, $sep, $end, ...$params );
107
113 public function isEmpty();
114
119 public function getArguments();
120
125 public function getNumberedArguments();
126
131 public function getNamedArguments();
132
138 public function getArgument( $name );
139
146 public function loopCheck( $title );
147
152 public function isTemplate();
153
165 public function setVolatile( $flag = true );
166
176 public function isVolatile();
177
190 public function getTTL();
191
201 public function setTTL( $ttl );
202
208 public function getTitle();
209}
210
212class_alias( PPFrame::class, 'PPFrame' );
array $params
The job parameters.
Represents a title within MediaWiki.
Definition Title.php:78
getTitle()
Get a title of frame.
virtualImplode( $sep,... $params)
Makes an object that, when expand()ed, will be the same as one obtained with implode()
getArgument( $name)
Get an argument to this frame by name.
isEmpty()
Returns true if there are no arguments in this frame.
getTTL()
Get the TTL of the frame's output.
isVolatile()
Get the "volatile" flag.
getNumberedArguments()
Returns all numbered arguments of this frame.
newChild( $args=false, $title=false, $indexOffset=0)
Create a child frame.
expand( $root, $flags=0)
Expand a document tree node.
loopCheck( $title)
Returns true if the infinite loop check is OK, false if a loop is detected.
getNamedArguments()
Returns all named arguments of this frame.
getArguments()
Returns all arguments of this frame.
isTemplate()
Return true if the frame is a template frame.
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.
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.
setVolatile( $flag=true)
Set the "volatile" flag.
virtualBracketedImplode( $start, $sep, $end,... $params)
Virtual implode with brackets.