Source for file counter.php

Documentation is available at counter.php

  1. <?php
  2.  
  3. /**
  4.  * Initiates a counter that is incremented every time you call it
  5.  * <pre>
  6.  *  * name : the counter name, define it if you want to have multiple concurrent counters
  7.  *  * start : the start value, if it's set, it will reset the counter to this value, defaults to 1
  8.  *  * skip : the value to add to the counter at each call, defaults to 1
  9.  *  * direction : "up" (default) or "down" to define whether the counter increments or decrements
  10.  *  * print : if false, the counter will not output the current count, defaults to true
  11.  *  * assign : if set, the counter is saved into the given variable and does not output anything, overriding the print parameter
  12.  * </pre>
  13.  * This software is provided 'as-is', without any express or implied warranty.
  14.  * In no event will the authors be held liable for any damages arising from the use of this software.
  15.  *
  16.  * This file is released under the LGPL
  17.  * "GNU Lesser General Public License"
  18.  * More information can be found here:
  19.  * {@link http://www.gnu.org/copyleft/lesser.html}
  20.  *
  21.  * @author     Jordi Boggiano <[email protected]>
  22.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  23.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  24.  * @link       http://dwoo.org/
  25.  * @version    0.9.1
  26.  * @date       2008-05-30
  27.  * @package    Dwoo
  28.  */
  29. class Dwoo_Plugin_counter extends Dwoo_Plugin
  30. {
  31.     protected $counters = array();
  32.  
  33.     public function process($name = 'default', $start = null, $skip = null, $direction = null, $print = null, $assign = null)
  34.     {
  35.         // init counter
  36.         if (!isset($this->counters[$name])) {
  37.             $this->counters[$name] = array
  38.             (
  39.                 'count'        =>    $start===null ? 1 : (int) $start,
  40.                 'skip'        =>    $skip===null ? 1 : (int) $skip,
  41.                 'print'        =>    $print===null ? true : (bool) $print,
  42.                 'assign'    =>    $assign===null ? null : (string) $assign,
  43.                 'direction'    =>    strtolower($direction)==='down' ? -1 : 1,
  44.             );
  45.         }
  46.         // increment
  47.         else
  48.         {
  49.             // override setting if present
  50.             if ($skip !== null) {
  51.                 $this->counters[$name]['skip'] = (int) $skip;
  52.             }
  53.  
  54.             if ($direction !== null) {
  55.                 $this->counters[$name]['direction'] = strtolower($direction)==='down' ? -1 : 1;
  56.             }
  57.  
  58.             if ($print !== null) {
  59.                 $this->counters[$name]['print'] = (bool) $print;
  60.             }
  61.  
  62.             if ($assign !== null) {
  63.                 $this->counters[$name]['assign'] = (string) $assign;
  64.             }
  65.  
  66.             if ($start !== null) {
  67.                 $this->counters[$name]['count'] = (int) $start;
  68.             } else {
  69.                 $this->counters[$name]['count'] += ($this->counters[$name]['skip'] * $this->counters[$name]['direction']);
  70.             }
  71.         }
  72.  
  73.         $out = $this->counters[$name]['count'];
  74.  
  75.         if ($this->counters[$name]['assign'] !== null) {
  76.             $this->dwoo->assignInScope($out, $this->counters[$name]['assign']);
  77.         } elseif ($this->counters[$name]['print'] === true) {
  78.             return $out;
  79.         }
  80.     }
  81. }

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