PPFrame_Hash Class Reference

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

Inheritance diagram for PPFrame_Hash:

Collaboration diagram for PPFrame_Hash:

List of all members.

Public Member Functions
	__construct ($preprocessor)
	Construct a new preprocessor frame.
	__toString ()
	expand ($root, $flags=0)
	getArgument ($name)
	getArguments ()
	getNamedArguments ()
	getNumberedArguments ()
	getPDBK ($level=false)
	getTitle ()
	Get a title of frame.
	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.
	loopCheck ($title)
	Returns true if the infinite loop check is OK, false if a loop is detected.
	newChild ($args=false, $title=false)
	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
	$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
	$preprocessor
	$title
	$titleCache

---

Detailed Description

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

Definition at line 823 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 858 of file Preprocessor_Hash.php.

References $preprocessor, and false.

---

Member Function Documentation

PPFrame_Hash::__toString

(

)

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1198 of file Preprocessor_Hash.php.

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

Exceptions:

MWException

Parameters:

$root
$flags	int

Returns:

string

Implements PPFrame.

Definition at line 911 of file Preprocessor_Hash.php.

References $out, Parser\MARKER_SUFFIX, PPFrame\NO_ARGS, PPFrame\NO_IGNORE, PPFrame\NO_TEMPLATES, PPFrame\RECOVER_COMMENTS, PPFrame\STRIP_COMMENTS, and virtualBracketedImplode().

Referenced by implode(), implodeWithFlags(), and newChild().

Here is the call graph for this function:

Here is the caller graph for this function:

PPFrame_Hash::getArgument

(

$

name

)

Parameters:

$name

Returns:

bool

Implements PPFrame.

Reimplemented in PPCustomFrame_Hash, and PPTemplateFrame_Hash.

Definition at line 1248 of file Preprocessor_Hash.php.

PPFrame_Hash::getArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1217 of file Preprocessor_Hash.php.

PPFrame_Hash::getNamedArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1231 of file Preprocessor_Hash.php.

PPFrame_Hash::getNumberedArguments

(

)

Returns:

array

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1224 of file Preprocessor_Hash.php.

PPFrame_Hash::getPDBK

(

$

level = false

)

Parameters:

$level

bool

Returns:

array|bool|String

Definition at line 1206 of file Preprocessor_Hash.php.

PPFrame_Hash::getTitle

(

)

Get a title of frame.

Returns:

Title

Implements PPFrame.

Definition at line 1277 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.

Returns:

string

Implements PPFrame.

Definition at line 1114 of file Preprocessor_Hash.php.

References expand().

Here is the call graph for this function:

PPFrame_Hash::implodeWithFlags	(	$	sep,
		$	flags
	)

Parameters:

$sep
$flags

Returns:

string

Implements PPFrame.

Definition at line 1085 of file Preprocessor_Hash.php.

References expand().

Here is the call graph for this function:

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 1240 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 1268 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 1259 of file Preprocessor_Hash.php.

References $title.

PPFrame_Hash::newChild	(	$	args = false,
		$	title = false
	)

Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.

Parameters:

$args	PPNode_Hash_Array|array
$title	Title|false

Returns:

PPTemplateFrame_Hash

Implements PPFrame.

Definition at line 876 of file Preprocessor_Hash.php.

References $title, expand(), and PPFrame\STRIP_COMMENTS.

Here is the call graph for this function:

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

Virtual implode with brackets.

Returns:

PPNode_Hash_Array

Implements PPFrame.

Definition at line 1173 of file Preprocessor_Hash.php.

References $out.

Referenced by expand().

Here is the caller graph for this function:

PPFrame_Hash::virtualImplode

(

$

sep

)

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

Returns:

PPNode_Hash_Array

Implements PPFrame.

Definition at line 1144 of file Preprocessor_Hash.php.

References $out.

---

Member Data Documentation

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

PPFrame_Hash::$parser

Definition at line 828 of file Preprocessor_Hash.php.

PPFrame_Hash::$preprocessor

Definition at line 833 of file Preprocessor_Hash.php.

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

PPFrame_Hash::$title

Definition at line 838 of file Preprocessor_Hash.php.

Referenced by PPTemplateFrame_Hash\__construct(), loopCheck(), and newChild().

PPFrame_Hash::$titleCache

Definition at line 839 of file Preprocessor_Hash.php.

---

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

• includes/parser/Preprocessor_Hash.php