eZ Publish  [trunk]
Public Member Functions | Public Attributes
eZTemplateForFunction Class Reference
Template functions

FOR 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 = 'for'

Detailed Description

FOR loop.

Syntax: 

    {for <number> to <number> as $itemVar [sequence <array> as $seqVar]}
        [{delimiter}...{/delimiter}]
        [{break}]
        [{continue}]
        [{skip}]
    {/for}

Examples: 

    {for 1 to 5 as $i}
        i: {$i}<br/>
    {/for}

    {for 5 to 1 as $i}
        i: {$i}<br/>
    {/for}

Definition at line 38 of file eztemplateforfunction.php.

Member Function Documentation

eZTemplateForFunction::attributeList ( )

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

Definition at line 56 of file eztemplateforfunction.php.

eZTemplateForFunction::functionList ( )

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

Definition at line 45 of file eztemplateforfunction.php.

eZTemplateForFunction::functionTemplateHints ( )

Returns the array with hits for the template compiler.

Definition at line 68 of file eztemplateforfunction.php.

eZTemplateForFunction::hasChildren ( )

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

Definition at line 210 of file eztemplateforfunction.php.

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

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

Definition at line 142 of file eztemplateforfunction.php.

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

Compiles the function and its children into PHP code.

Definition at line 79 of file eztemplateforfunction.php.

Member Data Documentation

const eZTemplateForFunction::FUNCTION_NAME = 'for'

Definition at line 40 of file eztemplateforfunction.php.

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

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