PPFrame Interface Reference
[Parser]

Inherited by PPFrame_DOM, and PPFrame_Hash.

List of all members.

Public Member Functions

 newChild ($args=false, $title=false)
 Create a child frame.
 expand ($root, $flags=0)
 Expand a document tree node.
 implodeWithFlags ($sep, $flags)
 Implode with flags for expand().
 implode ($sep)
 Implode with no flags specified.
 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.
 isEmpty ()
 Returns true if there are no arguments in this frame.
 getArguments ()
 Returns all arguments of this frame.
 getNumberedArguments ()
 Returns all numbered arguments of this frame.
 getNamedArguments ()
 Returns all named arguments of 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

const NO_ARGS = 1
const NO_TEMPLATES = 2
const STRIP_COMMENTS = 4
const NO_IGNORE = 8
const RECOVER_COMMENTS = 16
const RECOVER_ORIG = 27


Detailed Description

Definition at line 23 of file Preprocessor.php.


Member Function Documentation

PPFrame::expand ( root,
flags = 0 
)

Expand a document tree node.

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::getArgument ( name  ) 

Get an argument to this frame by name.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPCustomFrame_DOM, PPFrame_Hash, PPTemplateFrame_Hash, and PPCustomFrame_Hash.

PPFrame::getArguments (  ) 

Returns all arguments of this frame.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPFrame_Hash, and PPTemplateFrame_Hash.

PPFrame::getNamedArguments (  ) 

Returns all named arguments of this frame.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPFrame_Hash, and PPTemplateFrame_Hash.

PPFrame::getNumberedArguments (  ) 

Returns all numbered arguments of this frame.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPFrame_Hash, and PPTemplateFrame_Hash.

PPFrame::implode ( sep  ) 

Implode with no flags specified.

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::implodeWithFlags ( sep,
flags 
)

Implode with flags for expand().

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::isEmpty (  ) 

Returns true if there are no arguments in this frame.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPCustomFrame_DOM, PPFrame_Hash, PPTemplateFrame_Hash, and PPCustomFrame_Hash.

PPFrame::isTemplate (  ) 

Return true if the frame is a template frame.

Implemented in PPFrame_DOM, PPTemplateFrame_DOM, PPFrame_Hash, and PPTemplateFrame_Hash.

PPFrame::loopCheck ( title  ) 

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

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::newChild ( args = false,
title = false 
)

Create a child frame.

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::virtualBracketedImplode ( start,
sep,
end 
)

Virtual implode with brackets.

Implemented in PPFrame_DOM, and PPFrame_Hash.

PPFrame::virtualImplode ( sep  ) 

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

Implemented in PPFrame_DOM, and PPFrame_Hash.


Member Data Documentation

const PPFrame::NO_ARGS = 1

Definition at line 24 of file Preprocessor.php.

const PPFrame::NO_IGNORE = 8

Definition at line 27 of file Preprocessor.php.

Definition at line 25 of file Preprocessor.php.

Referenced by Parser::replaceVariables().

Definition at line 28 of file Preprocessor.php.


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

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