eZ Publish  [4.2]
eZTemplateSequenceFunction Class Reference

Wrapped array looping in templates using function "sequence". More...

List of all members.

Public Member Functions

 eZTemplateSequenceFunction ()
functionList ()
 functionTemplateHints ()
 hasChildren ()
 process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
 templateNodeSequenceCreate (&$node, $tpl, $parameters, $nameValue, $loopValue)
 templateNodeSequenceIterate (&$node, $tpl, $parameters, $nameValue)
 templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)

Public Attributes

 $SequenceName
 Name of sequence function.

Detailed Description

Wrapped array looping in templates using function "sequence".

This class allows for creating arrays which are looped independently of a section. This is useful if you want to create multiple sequences.

// Example of template code
{* Init the sequence *}
{sequence name=seq loop=array(2,5,7)}

{* Use it *}
{$seq:item}

{* Iterate it *}
{sequence name=seq}

Definition at line 53 of file eztemplatesequencefunction.php.


Member Function Documentation

eZTemplateSequenceFunction::eZTemplateSequenceFunction ( )

Initializes the function with the function name $inc_name.

Definition at line 58 of file eztemplatesequencefunction.php.

& eZTemplateSequenceFunction::functionList ( )

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

Definition at line 66 of file eztemplatesequencefunction.php.

eZTemplateSequenceFunction::functionTemplateHints ( )

Returns the array with hits for the template compiler.

Definition at line 75 of file eztemplatesequencefunction.php.

eZTemplateSequenceFunction::hasChildren ( )

Returns false, telling the template parser that this is a single tag.

Definition at line 198 of file eztemplatesequencefunction.php.

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

Either initializes the sequence or iterates it.

Definition at line 152 of file eztemplatesequencefunction.php.

eZTemplateSequenceFunction::templateNodeSequenceCreate ( &$  node,
tpl,
parameters,
nameValue,
loopValue 
)

Definition at line 83 of file eztemplatesequencefunction.php.

Referenced by templateNodeTransformation().

eZTemplateSequenceFunction::templateNodeSequenceIterate ( &$  node,
tpl,
parameters,
nameValue 
)

Definition at line 98 of file eztemplatesequencefunction.php.

Referenced by templateNodeTransformation().

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

Definition at line 111 of file eztemplatesequencefunction.php.


Member Data Documentation

eZTemplateSequenceFunction::$SequenceName

Name of sequence function.

Definition at line 204 of file eztemplatesequencefunction.php.


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