Source for file cycle.php

Documentation is available at cycle.php

  1. <?php
  2.  
  3. /**
  4.  * Cycles between several values and returns one of them on each call
  5.  * <pre>
  6.  *  * name : the cycler name, specify if you need to have multiple concurrent cycles running
  7.  *  * values : an array of values or a string of values delimited by $delimiter
  8.  *  * print : if false, the pointer will go to the next one but not print anything
  9.  *  * advance : if false, the pointer will not advance to the next value
  10.  *  * delimiter : the delimiter used to split values if they are provided as a string
  11.  *  * assign : if set, the value is saved in that variable instead of being output
  12.  *  * reset : if true, the pointer is reset to the first value
  13.  * </pre>
  14.  * This software is provided 'as-is', without any express or implied warranty.
  15.  * In no event will the authors be held liable for any damages arising from the use of this software.
  16.  *
  17.  * This file is released under the LGPL
  18.  * "GNU Lesser General Public License"
  19.  * More information can be found here:
  20.  * {@link http://www.gnu.org/copyleft/lesser.html}
  21.  *
  22.  * @author     Jordi Boggiano <[email protected]>
  23.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  24.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  25.  * @link       http://dwoo.org/
  26.  * @version    0.9.1
  27.  * @date       2008-05-30
  28.  * @package    Dwoo
  29.  */
  30. class Dwoo_Plugin_cycle extends Dwoo_Plugin
  31. {
  32.     protected $cycles = array();
  33.  
  34.     public function process($name = 'default', $values = null, $print = true, $advance = true, $delimiter = ',', $assign = null, $reset = false)
  35.     {
  36.         if ($values !== null) {
  37.             if (is_string($values)) {
  38.                 $values = explode($delimiter, $values);
  39.             }
  40.  
  41.             if (!isset($this->cycles[$name]) || $this->cycles[$name]['values'] !== $values) {
  42.                 $this->cycles[$name]['index'] = 0;
  43.             }
  44.  
  45.             $this->cycles[$name]['values'] = array_values($values);
  46.         } elseif (isset($this->cycles[$name])) {
  47.             $values = $this->cycles[$name]['values'];
  48.         }
  49.  
  50.         if ($reset) {
  51.             $this->cycles[$name]['index'] = 0;
  52.         }
  53.  
  54.         if ($print) {
  55.             $out = $values[$this->cycles[$name]['index']];
  56.         } else {
  57.             $out = null;
  58.         }
  59.  
  60.         if ($advance) {
  61.             if ($this->cycles[$name]['index'] >= count($values)-1) {
  62.                 $this->cycles[$name]['index'] = 0;
  63.             } else {
  64.                 $this->cycles[$name]['index']++;
  65.             }
  66.         }
  67.  
  68.         if ($assign !== null) {
  69.             $this->dwoo->assignInScope($assign, $out);
  70.         } else {
  71.             return $out;
  72.         }
  73.     }
  74. }

Documentation generated on Sun, 03 Aug 2008 15:12:26 +0200 by phpDocumentor 1.4.0