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

Inheritance diagram for PPFrame_DOM:

Collaboration diagram for PPFrame_DOM:

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, $indexOffset=0)
	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	$parser
Preprocessor	$preprocessor
Title	$title
	$titleCache

Detailed Description

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

Definition at line 887 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 919 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 1315 of file Preprocessor_DOM.php.

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

Exceptions:

MWException

Parameters:

$root
$flags	int

Returns:: string

Implements PPFrame.

Definition at line 978 of file Preprocessor_DOM.php.

PPFrame_DOM::getArgument ( $ name )

Get an argument to this frame by name.

Implements PPFrame.

Reimplemented in PPCustomFrame_DOM, and PPTemplateFrame_DOM.

Definition at line 1357 of file Preprocessor_DOM.php.

PPFrame_DOM::getArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPCustomFrame_DOM, and PPTemplateFrame_DOM.

Definition at line 1330 of file Preprocessor_DOM.php.

PPFrame_DOM::getNamedArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1344 of file Preprocessor_DOM.php.

PPFrame_DOM::getNumberedArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1337 of file Preprocessor_DOM.php.

PPFrame_DOM::getPDBK ( $ level = false )

Definition at line 1319 of file Preprocessor_DOM.php.

PPFrame_DOM::getTitle ( )

Get a title of frame.

Returns:: Title

Implements PPFrame.

Definition at line 1384 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 1232 of file Preprocessor_DOM.php.

PPFrame_DOM::implodeWithFlags	(	$	sep,
		$	flags
	)

Parameters:

$sep
$flags

Returns:: string

Implements PPFrame.

Definition at line 1204 of file Preprocessor_DOM.php.

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 1353 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 1375 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 1366 of file Preprocessor_DOM.php.

PPFrame_DOM::newChild	(	$	args = `false`,
		$	title = `false`,
		$	indexOffset = `0`
	)

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 934 of file Preprocessor_DOM.php.

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

Virtual implode with brackets.

Returns:: array

Implements PPFrame.

Definition at line 1290 of file Preprocessor_DOM.php.

References $out.

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 1262 of file Preprocessor_DOM.php.

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 912 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 906 of file Preprocessor_DOM.php.

Parser PPFrame_DOM::$parser

Definition at line 895 of file Preprocessor_DOM.php.

Preprocessor PPFrame_DOM::$preprocessor

Definition at line 891 of file Preprocessor_DOM.php.

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

Title PPFrame_DOM::$title

Definition at line 899 of file Preprocessor_DOM.php.

PPFrame_DOM::$titleCache

Definition at line 900 of file Preprocessor_DOM.php.

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

includes/parser/Preprocessor_DOM.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation