eZPublish(LegacyStack)  5.1
eZTemplateForFunction Class Reference

FOR loop. More...

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}

Member Function Documentation

eZTemplateForFunction::attributeList ( )

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

eZTemplateForFunction::functionList ( )

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

eZTemplateForFunction::functionTemplateHints ( )

Returns the array with hits for the template compiler.

eZTemplateForFunction::hasChildren ( )

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

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

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

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

Compiles the function and its children into PHP code.

Member Data Documentation

const eZTemplateForFunction::FUNCTION_NAME = 'for'

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