eZTemplateDoFunction Class Reference

DO..WHILE loop. More...

List of all members.

Public Member Functions
	attributeList ()
&	functionList ()
	functionTemplateHints ()
	hasChildren ()
	process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
	templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)
Public Attributes
const	FUNCTION_NAME = 'do'

---

Detailed Description

DO..WHILE loop.

Syntax:

    {do}
        [{delimiter}...{/delimiter}]
        [{break}]
        [{continue}]
        [{skip}]
    {/do while <condition> [sequence <array> as $seqVar]}

Example:

    {do}
        One more beer, please.
    {/do while eq( $drunk, false() )}

Definition at line 54 of file eztemplatedofunction.php.

---

Member Function Documentation

eZTemplateDoFunction::attributeList

(

)

Returns the attribute list key: parameter name value: can have children

Definition at line 72 of file eztemplatedofunction.php.

& eZTemplateDoFunction::functionList

(

)

Returns an array of the function names, required for eZTemplate::registerFunctions().

Definition at line 61 of file eztemplatedofunction.php.

eZTemplateDoFunction::functionTemplateHints

(

)

Returns the array with hits for the template compiler.

Definition at line 84 of file eztemplatedofunction.php.

eZTemplateDoFunction::hasChildren

(

)

Returns true, telling the template parser that the function can have children.

Definition at line 166 of file eztemplatedofunction.php.

eZTemplateDoFunction::process	(	$	tpl,
		&$	textElements,
		$	functionName,
		$	functionChildren,
		$	functionParameters,
		$	functionPlacement,
		$	rootNamespace,
		$	currentNamespace
	)

Actually executes the function and its children (in processed mode).

Definition at line 133 of file eztemplatedofunction.php.

eZTemplateDoFunction::templateNodeTransformation	(	$	functionName,
		&$	node,
		$	tpl,
		$	parameters,
		$	privateData
	)

Compiles the function and its children into PHP code.

Definition at line 95 of file eztemplatedofunction.php.

---

Member Data Documentation

const eZTemplateDoFunction::FUNCTION_NAME = 'do'

Definition at line 56 of file eztemplatedofunction.php.

Referenced by functionList(), functionTemplateHints(), process(), and templateNodeTransformation().

---

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

• eztemplatedofunction.php