PPFrame_DOM Class Reference
[Parser]

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

Inherits PPFrame.

Inherited by PPCustomFrame_DOM, and PPTemplateFrame_DOM.

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 806 of file Preprocessor_DOM.php.


Constructor & Destructor Documentation

PPFrame_DOM::__construct ( preprocessor  ) 

Construct a new preprocessor frame.

Parameters:
Preprocessor $preprocessor The parent preprocessor

Definition at line 827 of file Preprocessor_DOM.php.

References $preprocessor.


Member Function Documentation

PPFrame_DOM::__toString (  ) 

Reimplemented in PPTemplateFrame_DOM, and PPCustomFrame_DOM.

Definition at line 1183 of file Preprocessor_DOM.php.

PPFrame_DOM::expand ( root,
flags = 0 
)

Expand a document tree node.

Implements PPFrame.

Definition at line 874 of file Preprocessor_DOM.php.

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

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

PPFrame_DOM::getArgument ( name  ) 

Get an argument to this frame by name.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM, and PPCustomFrame_DOM.

Definition at line 1214 of file Preprocessor_DOM.php.

PPFrame_DOM::getArguments (  ) 

Returns all arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1195 of file Preprocessor_DOM.php.

PPFrame_DOM::getNamedArguments (  ) 

Returns all named arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1203 of file Preprocessor_DOM.php.

PPFrame_DOM::getNumberedArguments (  ) 

Returns all numbered arguments of this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1199 of file Preprocessor_DOM.php.

PPFrame_DOM::getPDBK ( level = false  ) 

Definition at line 1187 of file Preprocessor_DOM.php.

PPFrame_DOM::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 1109 of file Preprocessor_DOM.php.

References $s, and expand().

PPFrame_DOM::implodeWithFlags ( sep,
flags 
)

Implode with flags for expand().

Implements PPFrame.

Definition at line 1083 of file Preprocessor_DOM.php.

References $s, and expand().

PPFrame_DOM::isEmpty (  ) 

Returns true if there are no arguments in this frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM, and PPCustomFrame_DOM.

Definition at line 1210 of file Preprocessor_DOM.php.

PPFrame_DOM::isTemplate (  ) 

Return true if the frame is a template frame.

Implements PPFrame.

Reimplemented in PPTemplateFrame_DOM.

Definition at line 1228 of file Preprocessor_DOM.php.

PPFrame_DOM::loopCheck ( title  ) 

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

Implements PPFrame.

Definition at line 1221 of file Preprocessor_DOM.php.

References $title.

PPFrame_DOM::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 840 of file Preprocessor_DOM.php.

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

PPFrame_DOM::virtualBracketedImplode ( start,
sep,
end 
)

Virtual implode with brackets.

Implements PPFrame.

Definition at line 1160 of file Preprocessor_DOM.php.

References $out.

Referenced by expand().

PPFrame_DOM::virtualImplode ( sep  ) 

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

Implements PPFrame.

Definition at line 1135 of file Preprocessor_DOM.php.

References $out.


Member Data Documentation

PPFrame_DOM::$depth

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

Definition at line 820 of file Preprocessor_DOM.php.

PPFrame_DOM::$loopCheckHash

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

Definition at line 814 of file Preprocessor_DOM.php.

PPFrame_DOM::$parser

Definition at line 807 of file Preprocessor_DOM.php.

PPFrame_DOM::$preprocessor

PPFrame_DOM::$title

PPFrame_DOM::$titleCache

Definition at line 808 of file Preprocessor_DOM.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