MediaWiki master
PPFrame.php
Go to the documentation of this file.
1<?php
8namespace MediaWiki\Parser;
9
11
18interface PPFrame {
19 public const NO_ARGS = 1;
20 public const NO_TEMPLATES = 2;
21 public const STRIP_COMMENTS = 4;
22 public const NO_IGNORE = 8;
23 public const RECOVER_COMMENTS = 16;
24 public const NO_TAGS = 32;
25 public const PROCESS_NOWIKI = 64;
26
27 public const RECOVER_ORIG = self::NO_ARGS | self::NO_TEMPLATES | self::NO_IGNORE |
28 self::RECOVER_COMMENTS | self::NO_TAGS;
29
39 public function newChild( $args = false, $title = false, $indexOffset = 0 );
40
48 public function cachedExpand( $key, $root, $flags = 0 );
49
56 public function expand( $root, $flags = 0 );
57
65 public function implodeWithFlags( $sep, $flags, ...$params );
66
73 public function implode( $sep, ...$params );
74
82 public function virtualImplode( $sep, ...$params );
83
92 public function virtualBracketedImplode( $start, $sep, $end, ...$params );
93
99 public function isEmpty();
100
105 public function getArguments();
106
111 public function getNumberedArguments();
112
117 public function getNamedArguments();
118
124 public function getArgument( $name );
125
132 public function loopCheck( $title );
133
138 public function isTemplate();
139
151 public function setVolatile( $flag = true );
152
162 public function isVolatile();
163
177 public function getTTL();
178
191 public function setTTL( $ttl );
192
198 public function getTitle();
199}
200
202class_alias( PPFrame::class, 'PPFrame' );
Represents a title within MediaWiki.
Definition Title.php:69
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.