PPFrame Interface Reference

Inheritance diagram for PPFrame:

Public Member Functions
	expand ( $root, $flags=0)
	Expand a document tree node. More...
	getArgument ( $name)
	Get an argument to this frame by name. More...
	getArguments ()
	Returns all arguments of this frame. More...
	getNamedArguments ()
	Returns all named arguments of this frame. More...
	getNumberedArguments ()
	Returns all numbered arguments of this frame. More...
	getTitle ()
	Get a title of frame. More...
	implode ( $sep)
	Implode with no flags specified. More...
	implodeWithFlags ( $sep, $flags)
	Implode with flags for expand() More...
	isEmpty ()
	Returns true if there are no arguments in this frame. More...
	isTemplate ()
	Return true if the frame is a template frame. More...
	loopCheck ( $title)
	Returns true if the infinite loop check is OK, false if a loop is detected. More...
	newChild ( $args=false, $title=false, $indexOffset=0)
	Create a child frame. More...
	virtualBracketedImplode ( $start, $sep, $end)
	Virtual implode with brackets. More...
	virtualImplode ( $sep)
	Makes an object that, when expand()ed, will be the same as one obtained with implode() More...

Public Attributes
const	NO_ARGS = 1
const	NO_IGNORE = 8
const	NO_TEMPLATES = 2
const	RECOVER_COMMENTS = 16
const	RECOVER_ORIG = 27
const	STRIP_COMMENTS = 4
const	SUPPORTS_INDEX_OFFSET = 1
	This constant exists when $indexOffset is supported in newChild() More...

Detailed Description

Definition at line 72 of file Preprocessor.php.

Member Function Documentation

expand()

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

Expand a document tree node.

Implemented in PPFrame_DOM, and PPFrame_Hash.

getArgument()

PPFrame::getArgument

(

$name

)

Get an argument to this frame by name.

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

getArguments()

PPFrame::getArguments

(

)

Returns all arguments of this frame.

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

getNamedArguments()

PPFrame::getNamedArguments

(

)

Returns all named arguments of this frame.

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

getNumberedArguments()

PPFrame::getNumberedArguments

(

)

Returns all numbered arguments of this frame.

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

getTitle()

PPFrame::getTitle

(

)

Get a title of frame.

Returns

Title

Implemented in PPFrame_DOM, and PPFrame_Hash.

implode()

PPFrame::implode

(

$sep

)

Implode with no flags specified.

Implemented in PPFrame_DOM, and PPFrame_Hash.

implodeWithFlags()

PPFrame::implodeWithFlags	(		$sep,
			$flags
	)

Implode with flags for expand()

Implemented in PPFrame_DOM, and PPFrame_Hash.

isEmpty()

PPFrame::isEmpty

(

)

Returns true if there are no arguments in this frame.

Returns

bool

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

isTemplate()

PPFrame::isTemplate

(

)

Return true if the frame is a template frame.

Implemented in PPTemplateFrame_DOM, PPTemplateFrame_Hash, PPFrame_DOM, and PPFrame_Hash.

loopCheck()

PPFrame::loopCheck

(

$title

)

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

Parameters

$title

Returns

bool

Implemented in PPFrame_DOM, and PPFrame_Hash.

newChild()

PPFrame::newChild	(		$args = false,
			$title = false,
			$indexOffset = 0
	)

Create a child frame.

Parameters

array	$args
Title	$title
int	$indexOffset	A number subtracted from the index attributes of the arguments

Returns

PPFrame

Implemented in PPFrame_DOM, and PPFrame_Hash.

virtualBracketedImplode()

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

Virtual implode with brackets.

Implemented in PPFrame_DOM, and PPFrame_Hash.

virtualImplode()

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

NO_ARGS

const PPFrame::NO_ARGS = 1

Definition at line 73 of file Preprocessor.php.

Referenced by PPFrame_Hash\expand(), and PPFrame_DOM\expand().

NO_IGNORE

const PPFrame::NO_IGNORE = 8

Definition at line 76 of file Preprocessor.php.

Referenced by PPFrame_Hash\expand(), and PPFrame_DOM\expand().

NO_TEMPLATES

const PPFrame::NO_TEMPLATES = 2

Definition at line 74 of file Preprocessor.php.

Referenced by PPFrame_Hash\expand(), and PPFrame_DOM\expand().

RECOVER_COMMENTS

const PPFrame::RECOVER_COMMENTS = 16

Definition at line 77 of file Preprocessor.php.

Referenced by PPFrame_Hash\expand(), and PPFrame_DOM\expand().

RECOVER_ORIG

const PPFrame::RECOVER_ORIG = 27

Definition at line 79 of file Preprocessor.php.

STRIP_COMMENTS

const PPFrame::STRIP_COMMENTS = 4

Definition at line 75 of file Preprocessor.php.

Referenced by PPFrame_Hash\expand(), PPFrame_DOM\expand(), PPTemplateFrame_Hash\getNamedArgument(), PPTemplateFrame_DOM\getNamedArgument(), PPTemplateFrame_Hash\getNumberedArgument(), PPTemplateFrame_DOM\getNumberedArgument(), PPFrame_Hash\newChild(), PPFrame_DOM\newChild(), and CoreParserFunctions\tagObj().

SUPPORTS_INDEX_OFFSET

const PPFrame::SUPPORTS_INDEX_OFFSET = 1

This constant exists when $indexOffset is supported in newChild()

Definition at line 82 of file Preprocessor.php.

---

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

• includes/parser/Preprocessor.php