3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
27 const NO_TEMPLATES
= 2;
28 const STRIP_COMMENTS
= 4;
30 const RECOVER_COMMENTS
= 16;
33 const RECOVER_ORIG
= self
::NO_ARGS | self
::NO_TEMPLATES | self
::NO_IGNORE |
34 self
::RECOVER_COMMENTS | self
::NO_TAGS
;
36 /** This constant exists when $indexOffset is supported in newChild() */
37 const SUPPORTS_INDEX_OFFSET
= 1;
40 * Create a child frame
42 * @param array|bool $args
43 * @param bool|Title $title
44 * @param int $indexOffset A number subtracted from the index attributes of the arguments
48 public function newChild( $args = false, $title = false, $indexOffset = 0 );
51 * Expand a document tree node, caching the result on its parent with the given key
52 * @param string|int $key
53 * @param string|PPNode $root
57 public function cachedExpand( $key, $root, $flags = 0 );
60 * Expand a document tree node
61 * @param string|PPNode $root
65 public function expand( $root, $flags = 0 );
68 * Implode with flags for expand()
71 * @param string|PPNode $args,...
72 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
75 public function implodeWithFlags( $sep, $flags /*, ... */ );
78 * Implode with no flags specified
80 * @param string|PPNode $args,...
81 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
84 public function implode( $sep /*, ... */ );
87 * Makes an object that, when expand()ed, will be the same as one obtained
90 * @param string|PPNode ...$args
91 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
94 public function virtualImplode( $sep /* ...$args */ );
97 * Virtual implode with brackets
98 * @param string $start
101 * @param string|PPNode ...$args
102 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
105 public function virtualBracketedImplode( $start, $sep, $end /* ...$args */ );
108 * Returns true if there are no arguments in this frame
112 public function isEmpty();
115 * Returns all arguments of this frame
118 public function getArguments();
121 * Returns all numbered arguments of this frame
124 public function getNumberedArguments();
127 * Returns all named arguments of this frame
130 public function getNamedArguments();
133 * Get an argument to this frame by name
134 * @param int|string $name
135 * @return string|bool
137 public function getArgument( $name );
140 * Returns true if the infinite loop check is OK, false if a loop is detected
142 * @param Title $title
145 public function loopCheck( $title );
148 * Return true if the frame is a template frame
151 public function isTemplate();
154 * Set the "volatile" flag.
156 * Note that this is somewhat of a "hack" in order to make extensions
157 * with side effects (such as Cite) work with the PHP parser. New
158 * extensions should be written in a way that they do not need this
159 * function, because other parsers (such as Parsoid) are not guaranteed
160 * to respect it, and it may be removed in the future.
164 public function setVolatile( $flag = true );
167 * Get the "volatile" flag.
169 * Callers should avoid caching the result of an expansion if it has the
172 * @see self::setVolatile()
175 public function isVolatile();
178 * Get the TTL of the frame's output.
180 * This is the maximum amount of time, in seconds, that this frame's
181 * output should be cached for. A value of null indicates that no
182 * maximum has been specified.
184 * Note that this TTL only applies to caching frames as parts of pages.
185 * It is not relevant to caching the entire rendered output of a page.
189 public function getTTL();
192 * Set the TTL of the output of this frame and all of its ancestors.
193 * Has no effect if the new TTL is greater than the one already set.
194 * Note that it is the caller's responsibility to change the cache
195 * expiry of the page as a whole, if such behavior is desired.
197 * @see self::getTTL()
200 public function setTTL( $ttl );
203 * Get a title of frame
207 public function getTitle();