CycleViewHelper.php

Go to the documentation of this file.

<?php

/*                                                                        *
 * This script belongs to the FLOW3 package "Fluid".                      *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, either version 3 of the License, or (at your *
 * option) any later version.                                             *
 *                                                                        *
 * This script is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
 * General Public License for more details.                               *
 *                                                                        *
 * You should have received a copy of the GNU Lesser General Public       *
 * License along with the script.                                         *
 * If not, see http://www.gnu.org/licenses/lgpl.html                      *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

/**
 * This ViewHelper cycles through the specified values.
 * This can be often used to specify CSS classes for example.
 *
 * = Examples =
 *
 * <code title="Simple">
 * <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>
 * </code>
 * <output>
 * foobarbazfoo
 * </output>
 *
 * <code title="Alternating CSS class">
 * <ul>
 *   <f:for each="{0:1, 1:2, 2:3, 3:4}" as="foo">
 *     <f:cycle values="{0: 'odd', 1: 'even'}" as="zebraClass">
 *       <li class="{zebraClass}">{foo}</li>
 *     </f:cycle>
 *   </f:for>
 * </ul>
 * </code>
 * <output>
 * <ul>
 *   <li class="odd">1</li>
 *   <li class="even">2</li>
 *   <li class="odd">3</li>
 *   <li class="even">4</li>
 * </ul>
 * </output>
 *
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 * @api
 */
class Tx_Fluid_ViewHelpers_CycleViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {

    /**
     * @var array|Tx_Extbase_Persistence_ObjectStorage the values to be iterated through
     */
    protected $values = NULL;

    /**
     * @var integer current values index
     */
    protected $currentCycleIndex = NULL;

    /**
     * @param array $values The array or Tx_Extbase_Persistence_ObjectStorage to iterated over
     * @param string $as The name of the iteration variable
     * @return string Rendered result
     * @author Bastian Waidelich <bastian@typo3.org>
     * @api
     */
    public function render($values, $as) {
        if ($values === NULL) {
            return $this->renderChildren();
        }
        if ($this->values === NULL) {
            $this->initializeValues($values);
        }
        if ($this->currentCycleIndex === NULL || $this->currentCycleIndex >= count($this->values)) {
            $this->currentCycleIndex = 0;
        }

        $currentValue = isset($this->values[$this->currentCycleIndex]) ? $this->values[$this->currentCycleIndex] : NULL;
        $this->templateVariableContainer->add($as, $currentValue);
        $output = $this->renderChildren();
        $this->templateVariableContainer->remove($as);

        $this->currentCycleIndex ++;

        return $output;
    }

    /**
     * Sets this->values to the current values argument and resets $this->currentCycleIndex.
     *
     * @param array $values The array or Tx_Extbase_Persistence_ObjectStorage to be stored in $this->values
     * @return void
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    protected function initializeValues($values) {
        if (is_object($values)) {
            if (!$values instanceof Traversable) {
                throw new Tx_Fluid_Core_ViewHelper_Exception('CycleViewHelper only supports arrays and objects implementing Traversable interface' , 1248728393);
            }
            $this->values = iterator_to_array($values, FALSE);
        } else {
            $this->values = array_values($values);
        }
        $this->currentCycleIndex = 0;
    }
}

?>