PPTemplateFrame_Hash Class Reference

Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_Hash:

Collaboration diagram for PPTemplateFrame_Hash:

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_Hash
	__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)
	Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.
	implodeWithFlags ( $sep, $flags)
	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)
	Virtual implode with brackets.
	virtualImplode ( $sep)
	Makes an object that, when expand()ed, will be the same as one obtained with implode()

Public Attributes
	$namedArgs
	$namedExpansionCache
	$numberedArgs
	$numberedExpansionCache
	$parent
Public Attributes inherited from PPFrame_Hash
	$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_Hash
array	$childExpansionCache

Detailed Description

Expansion frame with template arguments.

Definition at line 1486 of file Preprocessor_Hash.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

Preprocessor	$preprocessor
bool | PPFrame	$parent
array	$numberedArgs
array	$namedArgs
bool | Title	$title

Definition at line 1498 of file Preprocessor_Hash.php.

Member Function Documentation

__toString()

PPTemplateFrame_Hash::__toString

(

)

Reimplemented from PPFrame_Hash.

Definition at line 1518 of file Preprocessor_Hash.php.

cachedExpand()

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

Exceptions

MWException

Parameters

string | int	$key
string | PPNode	$root
int	$flags

Returns

string

Reimplemented from PPFrame_Hash.

Definition at line 1542 of file Preprocessor_Hash.php.

getArgument()

PPTemplateFrame_Hash::getArgument

(

$name

)

Parameters

int | string

$name

Returns

string|bool

Reimplemented from PPFrame_Hash.

Definition at line 1635 of file Preprocessor_Hash.php.

getArguments()

PPTemplateFrame_Hash::getArguments

(

)

Returns

array

Reimplemented from PPFrame_Hash.

Definition at line 1565 of file Preprocessor_Hash.php.

getNamedArgument()

PPTemplateFrame_Hash::getNamedArgument

(

$name

)

Parameters

string

$name

Returns

string|bool

Definition at line 1619 of file Preprocessor_Hash.php.

getNamedArguments()

PPTemplateFrame_Hash::getNamedArguments

(

)

Returns

array

Reimplemented from PPFrame_Hash.

Definition at line 1589 of file Preprocessor_Hash.php.

getNumberedArgument()

PPTemplateFrame_Hash::getNumberedArgument

(

$index

)

Parameters

int

$index

Returns

string|bool

Definition at line 1601 of file Preprocessor_Hash.php.

getNumberedArguments()

PPTemplateFrame_Hash::getNumberedArguments

(

)

Returns

array

Reimplemented from PPFrame_Hash.

Definition at line 1578 of file Preprocessor_Hash.php.

isEmpty()

PPTemplateFrame_Hash::isEmpty

(

)

Returns true if there are no arguments in this frame.

Returns

bool

Reimplemented from PPFrame_Hash.

Definition at line 1558 of file Preprocessor_Hash.php.

isTemplate()

PPTemplateFrame_Hash::isTemplate

(

)

Return true if the frame is a template frame.

Returns

bool

Reimplemented from PPFrame_Hash.

Definition at line 1648 of file Preprocessor_Hash.php.

setTTL()

PPTemplateFrame_Hash::setTTL

(

$ttl

)

Set the TTL.

Parameters

int

$ttl

Reimplemented from PPFrame_Hash.

Definition at line 1657 of file Preprocessor_Hash.php.

setVolatile()

PPTemplateFrame_Hash::setVolatile

(

$flag = true

)

Set the volatile flag.

Parameters

bool

$flag

Reimplemented from PPFrame_Hash.

Definition at line 1652 of file Preprocessor_Hash.php.

Member Data Documentation

$namedArgs

PPTemplateFrame_Hash::$namedArgs

Definition at line 1488 of file Preprocessor_Hash.php.

$namedExpansionCache

PPTemplateFrame_Hash::$namedExpansionCache

Definition at line 1489 of file Preprocessor_Hash.php.

$numberedArgs

PPTemplateFrame_Hash::$numberedArgs

Definition at line 1488 of file Preprocessor_Hash.php.

$numberedExpansionCache

PPTemplateFrame_Hash::$numberedExpansionCache

Definition at line 1489 of file Preprocessor_Hash.php.

$parent

PPTemplateFrame_Hash::$parent

Definition at line 1488 of file Preprocessor_Hash.php.

---

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

• includes/parser/Preprocessor_Hash.php