Exponential 6.0.13 Exponential Enterprise Open Source CMS - PHP Class Reference

Public Member Functions | Public Attributes | List of all members
eZTemplateSequenceFunction Class Reference
Template system » Template functions

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

## Public Member Functions
| __construct ()
| functionList ()
| functionTemplateHints ()
| templateNodeSequenceCreate (&$node, $tpl, $parameters, $nameValue, $loopValue)
| templateNodeSequenceIterate (&$node, $tpl, $parameters, $nameValue)
| templateNodeTransformation ( $functionName, &$node, $tpl, $parameters, $privateData)
| process ( $tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
| hasChildren ()

## Public Attributes
| $SequenceName
| Name of sequence function. More...

## 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 33 of file eztemplatesequencefunction.php.

## Constructor & Destructor Documentation

## ◆ __construct()

eZTemplateSequenceFunction::__construct | ( |  | ) |

Definition at line 35 of file eztemplatesequencefunction.php.

## Member Function Documentation

## ◆ functionList()

eZTemplateSequenceFunction::functionList | ( |  | ) |

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

Definition at line 43 of file eztemplatesequencefunction.php.

## ◆ functionTemplateHints()

eZTemplateSequenceFunction::functionTemplateHints | ( |  | ) |

Returns the array with hits for the template compiler.

Definition at line 52 of file eztemplatesequencefunction.php.

## ◆ hasChildren()

eZTemplateSequenceFunction::hasChildren | ( |  | ) |

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

Definition at line 175 of file eztemplatesequencefunction.php.

## ◆ process()

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

Either initializes the sequence or iterates it.

Definition at line 129 of file eztemplatesequencefunction.php.

## ◆ templateNodeSequenceCreate()

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

Definition at line 60 of file eztemplatesequencefunction.php.

References eZTemplateNodeTool\createCodePieceNode(), eZTemplateNodeTool\createVariableNode(), eZTemplateNodeTool\createVariableUnsetNode(), and eZTemplateNodeTool\extractFunctionNodePlacement().

Referenced by templateNodeTransformation().

## ◆ templateNodeSequenceIterate()

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

Definition at line 75 of file eztemplatesequencefunction.php.

References eZTemplateNodeTool\createCodePieceNode().

Referenced by templateNodeTransformation().

## ◆ templateNodeTransformation()

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

Definition at line 88 of file eztemplatesequencefunction.php.

References eZTemplateNodeTool\createCodePieceNode(), eZTemplateNodeTool\elementConstantValue(), eZTemplateNodeTool\isConstantElement(), templateNodeSequenceCreate(), and templateNodeSequenceIterate().

## Member Data Documentation

## ◆ $SequenceName

eZTemplateSequenceFunction::$SequenceName

Name of sequence function.

Definition at line 181 of file eztemplatesequencefunction.php.

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

- eztemplatesequencefunction.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.