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

Inheritance diagram for PPFrame_Hash:

Collaboration diagram for PPFrame_Hash:

Public Member Functions
	__construct ($preprocessor)
	Construct a new preprocessor frame.
	__toString ()
	cachedExpand ($key, $root, $flags=0)
	expand ($root, $flags=0)
	getArgument ($name)
	getArguments ()
	getNamedArguments ()
	getNumberedArguments ()
	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)
	isEmpty ()
	Returns true if there are no arguments in this frame.
	isTemplate ()
	Return true if the frame is a template frame.
	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.
	setTTL ($ttl)
	Set the TTL.
	setVolatile ($flag=true)
	Set the volatile flag.
	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
Protected Attributes
array	$childExpansionCache
Private Attributes
	$ttl = null
	$volatile = false

Detailed Description

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

.

Definition at line 907 of file Preprocessor_Hash.php.

Constructor & Destructor Documentation

PPFrame_Hash::__construct ( $ preprocessor )

Construct a new preprocessor frame.

Parameters:

Preprocessor $preprocessor The parent preprocessor

Definition at line 946 of file Preprocessor_Hash.php.

References $preprocessor, array(), false, and title.

Member Function Documentation

PPFrame_Hash::__toString ( )

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1346 of file Preprocessor_Hash.php.

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

Exceptions:

MWException

Parameters:

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

Returns:: string

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1003 of file Preprocessor_Hash.php.

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

Exceptions:

MWException

Parameters:

string \| PPNode	$root
int	$flags

Returns:: string

Implements PPFrame.

Definition at line 1014 of file Preprocessor_Hash.php.

PPFrame_Hash::getArgument ( $ name )

Parameters:

string $name

Returns:: bool

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1396 of file Preprocessor_Hash.php.

PPFrame_Hash::getArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1365 of file Preprocessor_Hash.php.

PPFrame_Hash::getNamedArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1379 of file Preprocessor_Hash.php.

PPFrame_Hash::getNumberedArguments ( )

Returns:: array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1372 of file Preprocessor_Hash.php.

PPFrame_Hash::getPDBK ( $ level = false )

Parameters:

bool $level

Returns:: array|bool|string

Definition at line 1354 of file Preprocessor_Hash.php.

References title.

PPFrame_Hash::getTitle ( )

Get a title of frame.

Returns:: Title

Implements PPFrame.

Definition at line 1425 of file Preprocessor_Hash.php.

PPFrame_Hash::getTTL ( )

Get the TTL.

Returns:: int|null

Implements PPFrame.

Definition at line 1463 of file Preprocessor_Hash.php.

PPFrame_Hash::implode ( $ sep )

Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.

Parameters:

string	$sep
string \| PPNode	$args,...

Returns:: string

Implements PPFrame.

Definition at line 1256 of file Preprocessor_Hash.php.

PPFrame_Hash::implodeWithFlags	(	$	sep,
		$	flags
	)

Parameters:

string	$sep
int	$flags
string \| PPNode	$args,...

Returns:: string

Implements PPFrame.

Definition at line 1225 of file Preprocessor_Hash.php.

PPFrame_Hash::isEmpty ( )

Returns true if there are no arguments in this frame.

Returns:: bool

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1388 of file Preprocessor_Hash.php.

PPFrame_Hash::isTemplate ( )

Return true if the frame is a template frame.

Returns:: bool

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1416 of file Preprocessor_Hash.php.

PPFrame_Hash::isVolatile ( )

Get the volatile flag.

Returns:: bool

Implements PPFrame.

Definition at line 1443 of file Preprocessor_Hash.php.

PPFrame_Hash::loopCheck ( $ title )

Returns true if the infinite loop check is OK, false if a loop is detected.

Parameters:

Title $title

Returns:: bool

Implements PPFrame.

Definition at line 1407 of file Preprocessor_Hash.php.

PPFrame_Hash::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.

Parameters:

array \| bool \| PPNode_Hash_Array	$args
Title \| bool	$title
int	$indexOffset

Exceptions:

MWException

Returns:: PPTemplateFrame_Hash

Implements PPFrame.

Definition at line 966 of file Preprocessor_Hash.php.

PPFrame_Hash::setTTL ( $ ttl )

Set the TTL.

Parameters:

int $ttl

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1452 of file Preprocessor_Hash.php.

PPFrame_Hash::setVolatile ( $ flag = true )

Set the volatile flag.

Parameters:

bool $flag

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1434 of file Preprocessor_Hash.php.

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

Virtual implode with brackets.

Parameters:

string	$start
string	$sep
string	$end
string \| PPNode	$args,...

Returns:: PPNode_Hash_Array

Implements PPFrame.

Definition at line 1321 of file Preprocessor_Hash.php.

PPFrame_Hash::virtualImplode ( $ sep )

Makes an object that, when expand()ed, will be the same as one obtained with implode()

Parameters:

string	$sep
string \| PPNode	$args,...

Returns:: PPNode_Hash_Array

Implements PPFrame.

Definition at line 1288 of file Preprocessor_Hash.php.

Member Data Documentation

array PPFrame_Hash::$childExpansionCache [protected]

Definition at line 940 of file Preprocessor_Hash.php.

PPFrame_Hash::$depth

Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand()

Definition at line 933 of file Preprocessor_Hash.php.

PPFrame_Hash::$loopCheckHash

Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.

Definition at line 927 of file Preprocessor_Hash.php.

Parser PPFrame_Hash::$parser

Definition at line 912 of file Preprocessor_Hash.php.

Preprocessor PPFrame_Hash::$preprocessor

Definition at line 916 of file Preprocessor_Hash.php.

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

Title PPFrame_Hash::$title

Definition at line 920 of file Preprocessor_Hash.php.

PPFrame_Hash::$titleCache

Definition at line 921 of file Preprocessor_Hash.php.

PPFrame_Hash::$ttl = null [private]

Definition at line 936 of file Preprocessor_Hash.php.

PPFrame_Hash::$volatile = false [private]

Definition at line 935 of file Preprocessor_Hash.php.

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

includes/parser/Preprocessor_Hash.php

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation