Class Dwoo_Plugin_cycle

Description

Cycles between several values and returns one of them on each call

  * name : the cycler name, specify if you need to have multiple concurrent cycles running
  * values : an array of values or a string of values delimited by $delimiter
  * print : if false, the pointer will go to the next one but not print anything
  * advance : if false, the pointer will not advance to the next value
  * delimiter : the delimiter used to split values if they are provided as a string
  * assign : if set, the value is saved in that variable instead of being output
  * reset : if true, the pointer is reset to the first value
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

This file is released under the LGPL "GNU Lesser General Public License" More information can be found here: http://www.gnu.org/copyleft/lesser.html

Located in /plugins/builtin/functions/cycle.php (line 30)

Dwoo_Plugin
   |
   --Dwoo_Plugin_cycle
Variable Summary
mixed $cycles
Method Summary
void process ([ $name = 'default'], [ $values = null], [ $print = true], [ $advance = true], [ $delimiter = ','], [ $assign = null], [ $reset = false])
Variables
mixed $cycles = array() (line 32)
  • access: protected

Inherited Variables

Inherited from Dwoo_Plugin

Dwoo_Plugin::$dwoo
Methods
process (line 34)
  • access: public
void process ([ $name = 'default'], [ $values = null], [ $print = true], [ $advance = true], [ $delimiter = ','], [ $assign = null], [ $reset = false])
  • $name
  • $values
  • $print
  • $advance
  • $delimiter
  • $assign
  • $reset

Inherited Methods

Inherited From Dwoo_Plugin

Dwoo_Plugin::__construct()
Dwoo_Plugin::paramsToAttributes()

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