PPTemplateFrame_DOM Class Reference

Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_DOM:

Collaboration diagram for PPTemplateFrame_DOM:

Public Member Functions
	__construct ( $preprocessor, $parent=false, $numberedArgs=array(), $namedArgs=array(), $title=false)
	__toString ()
	getArgument ( $name)
	Get an argument to this frame by name. More...
	getArguments ()
	getNamedArgument ( $name)
	getNamedArguments ()
	getNumberedArgument ( $index)
	getNumberedArguments ()
	isEmpty ()
	Returns true if there are no arguments in this frame. More...
	isTemplate ()
	Return true if the frame is a template frame. More...
Public Member Functions inherited from PPFrame_DOM
	__construct ( $preprocessor)
	Construct a new preprocessor frame. More...
	expand ( $root, $flags=0)
	getPDBK ( $level=false)
	getTitle ()
	Get a title of frame. More...
	implode ( $sep)
	Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth. More...
	implodeWithFlags ( $sep, $flags)
	loopCheck ( $title)
	Returns true if the infinite loop check is OK, false if a loop is detected. More...
	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. More...
	virtualBracketedImplode ( $start, $sep, $end)
	Virtual implode with brackets. More...
	virtualImplode ( $sep)
	Makes an object that, when expand()ed, will be the same as one obtained with implode() More...

Public Attributes
	$namedArgs
	$namedExpansionCache
	$numberedArgs
	$numberedExpansionCache
PPFrame_DOM	$parent
Public Attributes inherited from PPFrame_DOM
	$depth
	Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand() More...
	$loopCheckHash
	Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames. More...
Parser	$parser
Preprocessor	$preprocessor
Title	$title
	$titleCache
Public Attributes inherited from PPFrame
const	NO_ARGS = 1
const	NO_IGNORE = 8
const	NO_TEMPLATES = 2
const	RECOVER_COMMENTS = 16
const	RECOVER_ORIG = 27
const	STRIP_COMMENTS = 4
const	SUPPORTS_INDEX_OFFSET = 1
	This constant exists when $indexOffset is supported in newChild() More...

Detailed Description

Expansion frame with template arguments.

Definition at line 1421 of file Preprocessor_DOM.php.

Constructor & Destructor Documentation

__construct()

PPTemplateFrame_DOM::__construct	(		$preprocessor,
			$parent = false,
			$numberedArgs = array(),
			$namedArgs = array(),
			$title = false
	)

Parameters

$preprocessor
$parent	PPFrame_DOM
$numberedArgs	array
$namedArgs	array
$title	Title

Definition at line 1436 of file Preprocessor_DOM.php.

References $namedArgs, $numberedArgs, $parent, PPFrame_DOM\$preprocessor, PPFrame_DOM\$title, array(), Title\getPrefixedDBkey(), and title.

Member Function Documentation

__toString()

PPTemplateFrame_DOM::__toString

(

)

Reimplemented from PPFrame_DOM.

Definition at line 1454 of file Preprocessor_DOM.php.

References $args, $name, $namedArgs, $s, $value, and as.

getArgument()

PPTemplateFrame_DOM::getArgument

(

$name

)

Get an argument to this frame by name.

Reimplemented from PPFrame_DOM.

Definition at line 1529 of file Preprocessor_DOM.php.

References $name, getNamedArgument(), and getNumberedArgument().

Referenced by getArguments(), getNamedArguments(), and getNumberedArguments().

getArguments()

PPTemplateFrame_DOM::getArguments

(

)

Returns

array

Reimplemented from PPFrame_DOM.

Definition at line 1480 of file Preprocessor_DOM.php.

References array(), as, and getArgument().

getNamedArgument()

PPTemplateFrame_DOM::getNamedArgument

(

$name

)

Definition at line 1517 of file Preprocessor_DOM.php.

References $name, and PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

getNamedArguments()

PPTemplateFrame_DOM::getNamedArguments

(

)

Returns

array

Reimplemented from PPFrame_DOM.

Definition at line 1498 of file Preprocessor_DOM.php.

References array(), as, and getArgument().

getNumberedArgument()

PPTemplateFrame_DOM::getNumberedArgument

(

$index

)

Definition at line 1506 of file Preprocessor_DOM.php.

References PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

getNumberedArguments()

PPTemplateFrame_DOM::getNumberedArguments

(

)

Returns

array

Reimplemented from PPFrame_DOM.

Definition at line 1490 of file Preprocessor_DOM.php.

References array(), as, and getArgument().

isEmpty()

PPTemplateFrame_DOM::isEmpty

(

)

Returns true if there are no arguments in this frame.

Returns

bool

Reimplemented from PPFrame_DOM.

Definition at line 1476 of file Preprocessor_DOM.php.

isTemplate()

PPTemplateFrame_DOM::isTemplate

(

)

Return true if the frame is a template frame.

Returns

bool

Reimplemented from PPFrame_DOM.

Definition at line 1542 of file Preprocessor_DOM.php.

Member Data Documentation

$namedArgs

PPTemplateFrame_DOM::$namedArgs

Definition at line 1422 of file Preprocessor_DOM.php.

Referenced by __construct(), and __toString().

$namedExpansionCache

PPTemplateFrame_DOM::$namedExpansionCache

Definition at line 1427 of file Preprocessor_DOM.php.

$numberedArgs

PPTemplateFrame_DOM::$numberedArgs

Definition at line 1422 of file Preprocessor_DOM.php.

Referenced by __construct().

$numberedExpansionCache

PPTemplateFrame_DOM::$numberedExpansionCache

Definition at line 1427 of file Preprocessor_DOM.php.

$parent

PPFrame_DOM PPTemplateFrame_DOM::$parent

Definition at line 1426 of file Preprocessor_DOM.php.

Referenced by __construct().

---

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

• includes/parser/Preprocessor_DOM.php