PPTemplateFrame_Hash Class Reference

Expansion frame with template arguments. More...

Inheritance diagram for PPTemplateFrame_Hash:

Collaboration diagram for PPTemplateFrame_Hash:

List of all members.

Public Member Functions
	__construct ($preprocessor, $parent=false, $numberedArgs=array(), $namedArgs=array(), $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 Attributes
	$namedArgs
	$namedExpansionCache
	$numberedArgs
	$numberedExpansionCache
	$parent

---

Detailed Description

Expansion frame with template arguments

.

Definition at line 1473 of file Preprocessor_Hash.php.

---

Constructor & Destructor Documentation

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

Parameters:

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

Definition at line 1486 of file Preprocessor_Hash.php.

---

Member Function Documentation

PPTemplateFrame_Hash::__toString

(

)

Reimplemented from PPFrame_Hash.

Definition at line 1506 of file Preprocessor_Hash.php.

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 1530 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::getArgument

(

$

name

)

Parameters:

string

$name

Returns:

array|bool

Reimplemented from PPFrame_Hash.

Definition at line 1623 of file Preprocessor_Hash.php.

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

PPTemplateFrame_Hash::getArguments

(

)

Returns:

array

Reimplemented from PPFrame_Hash.

Definition at line 1553 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::getNamedArgument

(

$

name

)

Parameters:

string

$name

Returns:

bool

Definition at line 1607 of file Preprocessor_Hash.php.

References $name.

Referenced by getArgument().

PPTemplateFrame_Hash::getNamedArguments

(

)

Returns:

array

Reimplemented from PPFrame_Hash.

Definition at line 1577 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::getNumberedArgument

(

$

index

)

Parameters:

int

$index

Returns:

array|bool

Definition at line 1589 of file Preprocessor_Hash.php.

Referenced by getArgument().

PPTemplateFrame_Hash::getNumberedArguments

(

)

Returns:

array

Reimplemented from PPFrame_Hash.

Definition at line 1566 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::isEmpty

(

)

Returns true if there are no arguments in this frame.

Returns:

bool

Reimplemented from PPFrame_Hash.

Definition at line 1546 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::isTemplate

(

)

Return true if the frame is a template frame.

Returns:

bool

Reimplemented from PPFrame_Hash.

Definition at line 1636 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::setTTL

(

$

ttl

)

Set the TTL.

Parameters:

int

$ttl

Reimplemented from PPFrame_Hash.

Definition at line 1645 of file Preprocessor_Hash.php.

References setVolatile().

PPTemplateFrame_Hash::setVolatile

(

$

flag = true

)

Set the volatile flag.

Parameters:

bool

$flag

Reimplemented from PPFrame_Hash.

Definition at line 1640 of file Preprocessor_Hash.php.

Referenced by setTTL().

---

Member Data Documentation

PPTemplateFrame_Hash::$namedArgs

Definition at line 1476 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::$namedExpansionCache

Definition at line 1477 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::$numberedArgs

Definition at line 1476 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::$numberedExpansionCache

Definition at line 1477 of file Preprocessor_Hash.php.

PPTemplateFrame_Hash::$parent

Definition at line 1476 of file Preprocessor_Hash.php.

---

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

• includes/parser/Preprocessor_Hash.php