PPFrame_DOM Class Reference

An expansion frame, used as a context to expand the result of preprocessToObj() More...

Inheritance diagram for PPFrame_DOM:

Collaboration diagram for PPFrame_DOM:

List of all members.

Public Member Functions
	__construct ($preprocessor)
	Construct a new preprocessor frame.
	__toString ()
	expand ($root, $flags=0)
	getArgument ($name)
	Get an argument to this frame by name.
	getArguments ()
	getNamedArguments ()
	getNumberedArguments ()
	getPDBK ($level=false)
	getTitle ()
	Get a title of frame.
	implode ($sep)
	Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.
	implodeWithFlags ($sep, $flags)
	isEmpty ()
	Returns true if there are no arguments in this frame.
	isTemplate ()
	Return true if the frame is a template frame.
	loopCheck ($title)
	Returns true if the infinite loop check is OK, false if a loop is detected.
	newChild ($args=false, $title=false)
	Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.
	virtualBracketedImplode ($start, $sep, $end)
	Virtual implode with brackets.
	virtualImplode ($sep)
	Makes an object that, when expand()ed, will be the same as one obtained with implode()
Public Attributes
	$depth
	Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand()
	$loopCheckHash
	Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.
	$parser
	$preprocessor
	$title
	$titleCache

---

Detailed Description

An expansion frame, used as a context to expand the result of preprocessToObj()

Definition at line 864 of file Preprocessor_DOM.php.

---

Constructor & Destructor Documentation

PPFrame_DOM::__construct

(

$

preprocessor

)

Construct a new preprocessor frame.

Parameters:

$preprocessor

Preprocessor The parent preprocessor

Definition at line 899 of file Preprocessor_DOM.php.

References $preprocessor, and false.

---

Member Function Documentation

PPFrame_DOM::__toString

(

)

Reimplemented in PPCustomFrame_DOM, and PPTemplateFrame_DOM.

Definition at line 1279 of file Preprocessor_DOM.php.

PPFrame_DOM::expand	(	$	root,
		$	flags = 0
	)

Exceptions:

MWException

Parameters:

$root
$flags	int

Returns:

string

Implements PPFrame.

Definition at line 954 of file Preprocessor_DOM.php.

References $count, $out, $title, Parser\MARKER_SUFFIX, PPFrame\NO_ARGS, PPFrame\NO_IGNORE, PPFrame\NO_TEMPLATES, PPFrame\RECOVER_COMMENTS, PPFrame\STRIP_COMMENTS, virtualBracketedImplode(), wfProfileIn(), and wfProfileOut().

Referenced by implode(), implodeWithFlags(), and newChild().

Here is the call graph for this function:

Here is the caller graph for this function:

PPFrame_DOM::getArgument

(

$

name

)

Get an argument to this frame by name.

Implements PPFrame.

Reimplemented in PPCustomFrame_DOM, and PPTemplateFrame_DOM.

Definition at line 1321 of file Preprocessor_DOM.php.

PPFrame_DOM::getArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1294 of file Preprocessor_DOM.php.

PPFrame_DOM::getNamedArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1308 of file Preprocessor_DOM.php.

PPFrame_DOM::getNumberedArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1301 of file Preprocessor_DOM.php.

PPFrame_DOM::getPDBK

(

$

level = false

)

Definition at line 1283 of file Preprocessor_DOM.php.

PPFrame_DOM::getTitle

(

)

Get a title of frame.

Returns:

Title

Implements PPFrame.

Definition at line 1348 of file Preprocessor_DOM.php.

PPFrame_DOM::implode

(

$

sep

)

Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.

Returns:

string

Implements PPFrame.

Definition at line 1197 of file Preprocessor_DOM.php.

References expand().

Here is the call graph for this function:

PPFrame_DOM::implodeWithFlags	(	$	sep,
		$	flags
	)

Parameters:

$sep
$flags

Returns:

string

Implements PPFrame.

Definition at line 1169 of file Preprocessor_DOM.php.

References expand().

Here is the call graph for this function:

PPFrame_DOM::isEmpty

(

)

Returns true if there are no arguments in this frame.

Returns:

bool

Implements PPFrame.

Reimplemented in PPCustomFrame_DOM, and PPTemplateFrame_DOM.

Definition at line 1317 of file Preprocessor_DOM.php.

PPFrame_DOM::isTemplate

(

)

Return true if the frame is a template frame.

Returns:

bool

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1339 of file Preprocessor_DOM.php.

PPFrame_DOM::loopCheck

(

$

title

)

Returns true if the infinite loop check is OK, false if a loop is detected.

Returns:

bool

Implements PPFrame.

Definition at line 1330 of file Preprocessor_DOM.php.

References $title.

PPFrame_DOM::newChild	(	$	args = false,
		$	title = false
	)

Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.

Returns:

PPTemplateFrame_DOM

Implements PPFrame.

Definition at line 914 of file Preprocessor_DOM.php.

References $title, expand(), and PPFrame\STRIP_COMMENTS.

Here is the call graph for this function:

PPFrame_DOM::virtualBracketedImplode	(	$	start,
		$	sep,
		$	end
	)

Virtual implode with brackets.

Implements PPFrame.

Definition at line 1254 of file Preprocessor_DOM.php.

References $out.

Referenced by expand().

Here is the caller graph for this function:

PPFrame_DOM::virtualImplode

(

$

sep

)

Makes an object that, when expand()ed, will be the same as one obtained with implode()

Returns:

array

Implements PPFrame.

Definition at line 1227 of file Preprocessor_DOM.php.

References $out.

---

Member Data Documentation

PPFrame_DOM::$depth

Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand()

Definition at line 892 of file Preprocessor_DOM.php.

PPFrame_DOM::$loopCheckHash

Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.

Definition at line 886 of file Preprocessor_DOM.php.

PPFrame_DOM::$parser

Definition at line 874 of file Preprocessor_DOM.php.

PPFrame_DOM::$preprocessor

Definition at line 869 of file Preprocessor_DOM.php.

Referenced by __construct(), PPTemplateFrame_DOM\__construct(), and PPCustomFrame_DOM\__construct().

PPFrame_DOM::$title

Definition at line 879 of file Preprocessor_DOM.php.

Referenced by PPTemplateFrame_DOM\__construct(), expand(), loopCheck(), and newChild().

PPFrame_DOM::$titleCache

Definition at line 880 of file Preprocessor_DOM.php.

---

The documentation for this class was generated from the following file:

• includes/parser/Preprocessor_DOM.php