PPFrame_Hash Class Reference
[Parser]

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

Inherits PPFrame.

Inherited by PPCustomFrame_Hash, and PPTemplateFrame_Hash.

List of all members.

Public Member Functions

 __construct ($preprocessor)
 Construct a new preprocessor frame.
 newChild ($args=false, $title=false)
 Create a new child frame $args is optionally a multi-root PPNode or array containing the template arguments.
 expand ($root, $flags=0)
 Expand a document tree node.
 implodeWithFlags ($sep, $flags)
 Implode with flags for expand().
 implode ($sep)
 Implode with no flags specified This previously called implodeWithFlags but has now been inlined to reduce stack depth.
 virtualImplode ($sep)
 Makes an object that, when expand()ed, will be the same as one obtained with implode().
 virtualBracketedImplode ($start, $sep, $end)
 Virtual implode with brackets.
 __toString ()
 getPDBK ($level=false)
 getArguments ()
 Returns all arguments of this frame.
 getNumberedArguments ()
 Returns all numbered arguments of this frame.
 getNamedArguments ()
 Returns all named arguments of this frame.
 isEmpty ()
 Returns true if there are no arguments in this frame.
 getArgument ($name)
 Get an argument to this frame by name.
 loopCheck ($title)
 Returns true if the infinite loop check is OK, false if a loop is detected.
 isTemplate ()
 Return true if the frame is a template frame.

Public Attributes

 $preprocessor
 $parser
 $title
 $titleCache
 $loopCheckHash
 Hashtable listing templates which are disallowed for expansion in this frame, having been encountered previously in parent frames.
 $depth
 Recursion depth of this frame, top = 0 Note that this is NOT the same as expansion depth in expand().


Detailed Description

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

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

References $preprocessor.


Member Function Documentation

PPFrame_Hash::__toString (  ) 

Reimplemented in PPTemplateFrame_Hash, and PPCustomFrame_Hash.

Definition at line 1130 of file Preprocessor_Hash.php.

PPFrame_Hash::expand ( root,
flags = 0 
)

Expand a document tree node.

Implements PPFrame.

Definition at line 852 of file Preprocessor_Hash.php.

References $out, $s, Parser::MARKER_SUFFIX, and virtualBracketedImplode().

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

PPFrame_Hash::getArgument ( name  ) 

Get an argument to this frame by name.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash, and PPCustomFrame_Hash.

Definition at line 1161 of file Preprocessor_Hash.php.

PPFrame_Hash::getArguments (  ) 

Returns all arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1142 of file Preprocessor_Hash.php.

PPFrame_Hash::getNamedArguments (  ) 

Returns all named arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1150 of file Preprocessor_Hash.php.

PPFrame_Hash::getNumberedArguments (  ) 

Returns all numbered arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1146 of file Preprocessor_Hash.php.

PPFrame_Hash::getPDBK ( level = false  ) 

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

Implements PPFrame.

Definition at line 1050 of file Preprocessor_Hash.php.

References $s, and expand().

PPFrame_Hash::implodeWithFlags ( sep,
flags 
)

Implode with flags for expand().

Implements PPFrame.

Definition at line 1022 of file Preprocessor_Hash.php.

References $s, and expand().

PPFrame_Hash::isEmpty (  ) 

Returns true if there are no arguments in this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash, and PPCustomFrame_Hash.

Definition at line 1157 of file Preprocessor_Hash.php.

PPFrame_Hash::isTemplate (  ) 

Return true if the frame is a template frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_Hash.

Definition at line 1175 of file Preprocessor_Hash.php.

PPFrame_Hash::loopCheck ( title  ) 

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

Implements PPFrame.

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

Implements PPFrame.

Definition at line 822 of file Preprocessor_Hash.php.

References $name, $title, expand(), and PPFrame::STRIP_COMMENTS.

PPFrame_Hash::virtualBracketedImplode ( start,
sep,
end 
)

Virtual implode with brackets.

Implements PPFrame.

Definition at line 1105 of file Preprocessor_Hash.php.

References $out.

Referenced by expand().

PPFrame_Hash::virtualImplode ( sep  ) 

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

Implements PPFrame.

Definition at line 1078 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 802 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 796 of file Preprocessor_Hash.php.

PPFrame_Hash::$parser

Definition at line 789 of file Preprocessor_Hash.php.

PPFrame_Hash::$preprocessor

PPFrame_Hash::$title

Definition at line 789 of file Preprocessor_Hash.php.

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

PPFrame_Hash::$titleCache

Definition at line 790 of file Preprocessor_Hash.php.


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

Generated on Sat Apr 30 22:57:45 2011 for MediaWiki by  doxygen 1.5.9