documentation/manual/en/module_specs/Zend_View-Helpers-Cycle.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect3 id="zend.view.helpers.initial.cycle">
   4     <title>Cycle Helper</title>
   5
   6     <para>
   7         The <classname>Cycle</classname> helper is used to alternate a set of values.
   8     </para>
   9
  10     <example id="zend.view.helpers.initial.cycle.basicusage">
  11         <title>Cycle Helper Basic Usage</title>
  12
  13         <para>
  14             To add elements to cycle just specify them in constructor
  15             or use <methodname>assign(array $data)</methodname> function
  16         </para>
  17
  18         <programlisting language="php"><![CDATA[
  19 <?php foreach ($this->books as $book):?>
  20   <tr style="background-color:<?php echo $this->cycle(array("#F0F0F0",
  21                                                             "#FFFFFF"))
  22                                               ->next()?>">
  23   <td><?php echo $this->escape($book['author']) ?></td>
  24 </tr>
  25 <?php endforeach;?>
  26
  27 // Moving in backwards order and assign function
  28 $this->cycle()->assign(array("#F0F0F0","#FFFFFF"));
  29 $this->cycle()->prev();
  30 ?>
  31 ]]></programlisting>
  32
  33         <para>
  34             The output
  35         </para>
  36
  37         <programlisting language="php"><![CDATA[
  38 <tr style="background-color:'#F0F0F0'">
  39    <td>First</td>
  40 </tr>
  41 <tr style="background-color:'#FFFFFF'">
  42    <td>Second</td>
  43 </tr>
  44 ]]></programlisting>
  45     </example>
  46
  47     <example id="zend.view.helpers.initial.cycle.advanceusage">
  48         <title>Working with two or more cycles</title>
  49
  50        <para>
  51            To use two cycles you have to specify the names of cycles. Just set second parameter in
  52            cycle method. <command>$this->cycle(array("#F0F0F0","#FFFFFF"),'cycle2')</command>. You
  53            can also use setName($name) function.
  54         </para>
  55     </example>
  56
  57     <programlisting language="php"><![CDATA[
  58 <?php foreach ($this->books as $book):?>
  59   <tr style="background-color:<?php echo $this->cycle(array("#F0F0F0",
  60                                                             "#FFFFFF"))
  61                                               ->next()?>">
  62   <td><?php echo $this->cycle(array(1,2,3),'number')->next()?></td>
  63   <td><?php echo $this->escape($book['author'])?></td>
  64 </tr>
  65 <?php endforeach;?>
  66 ]]></programlisting>
  67 </sect3>
  68 <!--
  69 vim:se ts=4 sw=4 et:
  70 -->