Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_DOM:

[legend]

Collaboration diagram for PPTemplateFrame_DOM:

[legend]

Public Member Functions
	__construct ( $preprocessor, $parent=false, $numberedArgs=[], $namedArgs=[], $title=false)

	__toString ()

	cachedExpand ( $key, $root, $flags=0)

	getArgument ( $name)

	getArguments ()

	getNamedArgument ( $name)

	getNamedArguments ()

	getNumberedArgument ( $index)

	getNumberedArguments ()

	isEmpty ()
	Returns true if there are no arguments in this frame.

	isTemplate ()
	Return true if the frame is a template frame.

	setTTL ( $ttl)
	Set the TTL.

	setVolatile ( $flag=true)
	Set the volatile flag.

Public Member Functions inherited from PPFrame_DOM
	__construct ( $preprocessor)
	Construct a new preprocessor frame.

	expand ( $root, $flags=0)

	getPDBK ( $level=false)

	getTitle ()
	Get a title of frame.

	getTTL ()
	Get the TTL.

	implode ( $sep,... $args)
	Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.

	implodeWithFlags ( $sep, $flags,... $args)

	isVolatile ()
	Get the volatile flag.

	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,... $args)
	Virtual implode with brackets.

	virtualImplode ( $sep,... $args)
	Makes an object that, when expand()ed, will be the same as one obtained with implode()

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()

	$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

Public Attributes inherited from PPFrame
const	NO_ARGS = 1

const	NO_IGNORE = 8

const	NO_TAGS = 32

const	NO_TEMPLATES = 2

const	RECOVER_COMMENTS = 16

const	RECOVER_ORIG

const	STRIP_COMMENTS = 4

const	SUPPORTS_INDEX_OFFSET = 1
	This constant exists when $indexOffset is supported in newChild()

Additional Inherited Members
Protected Attributes inherited from PPFrame_DOM
array	$childExpansionCache

Detailed Description

Expansion frame with template arguments.

Deprecated:: since 1.34, use PPTemplateFrame_Hash

Definition at line 28 of file PPTemplateFrame_DOM.php.

Constructor & Destructor Documentation

◆ __construct()

PPTemplateFrame_DOM::__construct	(	$preprocessor,
		$parent = `false`,
		$numberedArgs = `[]`,
		$namedArgs = `[]`,
		$title = `false`
	)

Parameters

Preprocessor	$preprocessor
bool \| PPFrame_DOM	$parent
array	$numberedArgs
array	$namedArgs
bool \| Title	$title

Definition at line 45 of file PPTemplateFrame_DOM.php.

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

Member Function Documentation

◆ __toString()

PPTemplateFrame_DOM::__toString ( )

Reimplemented from PPFrame_DOM.

Definition at line 65 of file PPTemplateFrame_DOM.php.

References $args, $namedArgs, and $s.

◆ cachedExpand()

PPTemplateFrame_DOM::cachedExpand	(	$key,
		$root,
		$flags = `0`
	)

Exceptions

MWException

Parameters

string \| int	$key
string \| PPNode_DOM \| DOMDocument	$root
int	$flags

Returns: string

Reimplemented from PPFrame_DOM.

Definition at line 89 of file PPTemplateFrame_DOM.php.

References PPFrame_DOM\expand(), and PPFrame_DOM\isVolatile().

◆ getArgument()

PPTemplateFrame_DOM::getArgument ( $name )

Parameters

int | string $name

Returns: string|bool

Reimplemented from PPFrame_DOM.

Definition at line 173 of file PPTemplateFrame_DOM.php.

References getNamedArgument(), and getNumberedArgument().

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

◆ getArguments()

PPTemplateFrame_DOM::getArguments ( )

Returns: array

Reimplemented from PPFrame_DOM.

Definition at line 109 of file PPTemplateFrame_DOM.php.

References getArgument().

◆ getNamedArgument()

PPTemplateFrame_DOM::getNamedArgument ( $name )

Parameters

string $name

Returns: string|bool

Definition at line 157 of file PPTemplateFrame_DOM.php.

References PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

◆ getNamedArguments()

PPTemplateFrame_DOM::getNamedArguments ( )

Returns: array

Reimplemented from PPFrame_DOM.

Definition at line 127 of file PPTemplateFrame_DOM.php.

References getArgument().

◆ getNumberedArgument()

PPTemplateFrame_DOM::getNumberedArgument ( $index )

Parameters

int $index

Returns: string|bool

Definition at line 139 of file PPTemplateFrame_DOM.php.

References PPFrame\STRIP_COMMENTS.

Referenced by getArgument().

◆ getNumberedArguments()

PPTemplateFrame_DOM::getNumberedArguments ( )

Returns: array

Reimplemented from PPFrame_DOM.

Definition at line 119 of file PPTemplateFrame_DOM.php.

References getArgument().

◆ isEmpty()

PPTemplateFrame_DOM::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns: bool

Reimplemented from PPFrame_DOM.

Definition at line 105 of file PPTemplateFrame_DOM.php.

◆ isTemplate()

PPTemplateFrame_DOM::isTemplate ( )

Return true if the frame is a template frame.

Returns: bool

Reimplemented from PPFrame_DOM.

Definition at line 186 of file PPTemplateFrame_DOM.php.

◆ setTTL()

PPTemplateFrame_DOM::setTTL ( $ttl )

Set the TTL.

Parameters

int $ttl

Reimplemented from PPFrame_DOM.

Definition at line 195 of file PPTemplateFrame_DOM.php.

References PPFrame_DOM\$ttl.

◆ setVolatile()

PPTemplateFrame_DOM::setVolatile ( $flag = true )

Set the volatile flag.

Parameters

bool $flag

Reimplemented from PPFrame_DOM.

Definition at line 190 of file PPTemplateFrame_DOM.php.

Member Data Documentation

◆ $namedArgs

PPTemplateFrame_DOM::$namedArgs

Definition at line 30 of file PPTemplateFrame_DOM.php.

Referenced by __construct(), and __toString().

◆ $namedExpansionCache

PPTemplateFrame_DOM::$namedExpansionCache

Definition at line 36 of file PPTemplateFrame_DOM.php.

◆ $numberedArgs

PPTemplateFrame_DOM::$numberedArgs

Definition at line 30 of file PPTemplateFrame_DOM.php.

Referenced by __construct().

◆ $numberedExpansionCache

PPTemplateFrame_DOM::$numberedExpansionCache

Definition at line 36 of file PPTemplateFrame_DOM.php.

◆ $parent

PPFrame_DOM PPTemplateFrame_DOM::$parent

Definition at line 35 of file PPTemplateFrame_DOM.php.

Referenced by __construct().

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

includes/parser/PPTemplateFrame_DOM.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ cachedExpand()

◆ getArgument()

◆ getArguments()

◆ getNamedArgument()

◆ getNamedArguments()

◆ getNumberedArgument()

◆ getNumberedArguments()

◆ isEmpty()

◆ isTemplate()

◆ setTTL()

◆ setVolatile()

Member Data Documentation

◆ $namedArgs

◆ $namedExpansionCache

◆ $numberedArgs

◆ $numberedExpansionCache

◆ $parent