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)
 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 803 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 824 of file Preprocessor_DOM.php.

References $preprocessor.


Member Function Documentation

PPFrame_DOM::__toString (  ) 

Reimplemented in PPTemplateFrame_DOM, and PPCustomFrame_DOM.

Definition at line 1180 of file Preprocessor_DOM.php.

PPFrame_DOM::expand ( root,
flags = 0 
)

Expand a document tree node.

Implements PPFrame.

Definition at line 871 of file Preprocessor_DOM.php.

References $count, $flags, $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 1199 of file Preprocessor_DOM.php.

PPFrame_DOM::getPDBK ( level = false  ) 

Definition at line 1184 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 1106 of file Preprocessor_DOM.php.

References $args, $s, $sep, and expand().

PPFrame_DOM::implodeWithFlags ( sep,
flags 
)

Implode with flags for expand().

Implements PPFrame.

Definition at line 1080 of file Preprocessor_DOM.php.

References $args, $flags, $s, $sep, 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 1195 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 1213 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 1206 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 837 of file Preprocessor_DOM.php.

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

PPFrame_DOM::virtualBracketedImplode ( start,
sep,
end 
)

Virtual implode with brackets.

Implements PPFrame.

Definition at line 1157 of file Preprocessor_DOM.php.

References $args, $end, $out, $sep, and $start.

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

References $args, $out, and $sep.


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

PPFrame_DOM::$parser

Definition at line 804 of file Preprocessor_DOM.php.

PPFrame_DOM::$preprocessor

PPFrame_DOM::$title

PPFrame_DOM::$titleCache

Definition at line 805 of file Preprocessor_DOM.php.


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

Generated on Sat Sep 5 02:08:44 2009 for MediaWiki by  doxygen 1.5.9