TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper Tx_Fluid_ViewHelpers_CycleViewHelper

Public Member Functions

 render ($values, $as)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 isEscapingInterceptorEnabled ()
 
 setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
 
 setRenderChildrenClosure (\Closure $renderChildrenClosure)
 
 initializeArgumentsAndRender ()
 
 initialize ()
 
 renderChildren ()
 
 prepareArguments ()
 
 validateArguments ()
 
 initializeArguments ()
 
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 
 resetState ()
 

Protected Member Functions

 initializeValues ($values)
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 callRenderMethod ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Protected Attributes

 $values = NULL
 
 $currentCycleIndex = NULL
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = NULL
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = TRUE
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 

Detailed Description

This ViewHelper cycles through the specified values. This can be often used to specify CSS classes for example. Note: To achieve the "zebra class" effect in a loop you can also use the "iteration" argument of the for ViewHelper.

= Examples =

<f:for each="{0:1, 1:2, 2:3, 3:4}" as="foo"><f:cycle values="{0: 'foo', 1: 'bar', 2: 'baz'}" as="cycle">{cycle}</f:cycle></f:for> <output> foobarbazfoo </output>

f:for each="{0:1, 1:2, 2:3, 3:4}" as="foo"> <f:cycle values="{0: 'odd', 1: 'even'}" as="zebraClass"> {foo} </f:cycle> </f:for> <output>

  • 1
  • 2
  • 3
  • 4

</output>

Definition at line 48 of file CycleViewHelper.php.

Member Function Documentation

◆ initializeValues()

TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper::initializeValues (   $values)
protected

Sets this->values to the current values argument and resets $this->currentCycleIndex.

Parameters
array | \Traversable$valuesThe array or to be stored in $this->values
Returns
void
Exceptions

Definition at line 98 of file CycleViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper\$values.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper\render().

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper::render (   $values,
  $as 
)
Parameters
array$valuesThe array or object implementing (for example ) to iterated over
string$asThe name of the iteration variable
Returns
string Rendered result

Definition at line 70 of file CycleViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper\$currentCycleIndex, TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper\$values, TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper\initializeValues(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren().

Member Data Documentation

◆ $currentCycleIndex

TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper::$currentCycleIndex = NULL
protected

◆ $values

TYPO3\CMS\Fluid\ViewHelpers\CycleViewHelper::$values = NULL
protected