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
25 * @property int $depth
26 * @property PPFrame $parent
30 const NO_TEMPLATES
= 2;
31 const STRIP_COMMENTS
= 4;
33 const RECOVER_COMMENTS
= 16;
36 const RECOVER_ORIG
= self
::NO_ARGS | self
::NO_TEMPLATES | self
::NO_IGNORE |
37 self
::RECOVER_COMMENTS | self
::NO_TAGS
;
39 /** This constant exists when $indexOffset is supported in newChild() */
40 const SUPPORTS_INDEX_OFFSET
= 1;
43 * Create a child frame
45 * @param array|bool $args
46 * @param bool|Title $title
47 * @param int $indexOffset A number subtracted from the index attributes of the arguments
51 public function newChild( $args = false, $title = false, $indexOffset = 0 );
54 * Expand a document tree node, caching the result on its parent with the given key
55 * @param string|int $key
56 * @param string|PPNode $root
60 public function cachedExpand( $key, $root, $flags = 0 );
63 * Expand a document tree node
64 * @param string|PPNode $root
68 public function expand( $root, $flags = 0 );
71 * Implode with flags for expand()
74 * @param string|PPNode $args,...
75 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
78 public function implodeWithFlags( $sep, $flags /*, ... */ );
81 * Implode with no flags specified
83 * @param string|PPNode $args,...
84 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
87 public function implode( $sep /*, ... */ );
90 * Makes an object that, when expand()ed, will be the same as one obtained
93 * @param string|PPNode ...$args
94 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
97 public function virtualImplode( $sep /* ...$args */ );
100 * Virtual implode with brackets
101 * @param string $start
104 * @param string|PPNode ...$args
105 * @suppress PhanCommentParamWithoutRealParam HHVM bug T228695#5450847
108 public function virtualBracketedImplode( $start, $sep, $end /* ...$args */ );
111 * Returns true if there are no arguments in this frame
115 public function isEmpty();
118 * Returns all arguments of this frame
121 public function getArguments();
124 * Returns all numbered arguments of this frame
127 public function getNumberedArguments();
130 * Returns all named arguments of this frame
133 public function getNamedArguments();
136 * Get an argument to this frame by name
137 * @param int|string $name
138 * @return string|bool
140 public function getArgument( $name );
143 * Returns true if the infinite loop check is OK, false if a loop is detected
145 * @param Title $title
148 public function loopCheck( $title );
151 * Return true if the frame is a template frame
154 public function isTemplate();
157 * Set the "volatile" flag.
159 * Note that this is somewhat of a "hack" in order to make extensions
160 * with side effects (such as Cite) work with the PHP parser. New
161 * extensions should be written in a way that they do not need this
162 * function, because other parsers (such as Parsoid) are not guaranteed
163 * to respect it, and it may be removed in the future.
167 public function setVolatile( $flag = true );
170 * Get the "volatile" flag.
172 * Callers should avoid caching the result of an expansion if it has the
175 * @see self::setVolatile()
178 public function isVolatile();
181 * Get the TTL of the frame's output.
183 * This is the maximum amount of time, in seconds, that this frame's
184 * output should be cached for. A value of null indicates that no
185 * maximum has been specified.
187 * Note that this TTL only applies to caching frames as parts of pages.
188 * It is not relevant to caching the entire rendered output of a page.
192 public function getTTL();
195 * Set the TTL of the output of this frame and all of its ancestors.
196 * Has no effect if the new TTL is greater than the one already set.
197 * Note that it is the caller's responsibility to change the cache
198 * expiry of the page as a whole, if such behavior is desired.
200 * @see self::getTTL()
203 public function setTTL( $ttl );
206 * Get a title of frame
210 public function getTitle();