Source for file Item.class.php

Documentation is available at Item.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Template
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Template List Item Class (for producing <li>...</li> tags)
  22.  *
  23.  * @category Gumbo
  24.  * @package Template
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Template List Item Class (for producing <li>...</li> tags)
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Template_List");
  34.  
  35. class Gumbo_Template_List_Item extends Gumbo_Template_List {
  36.     
  37.     /** ACTION METHODS **/
  38.     /**
  39.      * Returns the formatted text to the browser
  40.      * @param bool $reload reloads the output (not used)
  41.      * @return string 
  42.      */
  43.     public function fetch ($reload=false) {
  44.         $txt = null;
  45.  
  46.         $num = count ($this->getElements ()) - 1;
  47.         foreach ($this->getElements () as $key=>$val) {
  48.             $txt .= "<li";
  49.             if ($key == 0) { $txt .= " class=\"first\""; }
  50.             if ($num > 1 && $key == $num) { $txt .= " class=\"last\""; }
  51.             $txt .= ">" . $val . "</li>";
  52.         }
  53.  
  54.         return $txt;
  55.     }
  56.     
  57.     /**
  58.      * Adds data to the end of the list
  59.      * @param args[] $data 
  60.      * @throws Gumbo_Exception
  61.      */
  62.     public function add ($data) {
  63.         try {
  64.             // verify precondition
  65.             if (!is_string ($data) && !is_numeric ($data) && !is_array ($data)) {
  66.                 throw new Gumbo_Exception ("Invalid Argument 'data:str|num|arr' => {$data}:" . gettype ($data));
  67.             }
  68.             
  69.             if (func_num_args () > 1) {
  70.                 $data = func_get_args ();
  71.             }
  72.             
  73.             // recursive method call
  74.             if (is_array ($data)) {
  75.                 foreach ($data as $val) {
  76.                     $this->add ($val);
  77.                 }
  78.                 return;
  79.             }
  80.             
  81.             $this->_elements [] = $data;
  82.         } catch (Gumbo_Exception $e) {
  83.             $e->setFunction (__METHOD__);
  84.             gumbo_trigger ($e);
  85.         }
  86.     }
  87.  
  88.     /**
  89.      * Places the data at the specified location
  90.      * @param int $position 
  91.      * @param args[] $data 
  92.      * @throws Gumbo_Exception
  93.      */
  94.     public function place ($position, $data) {
  95.         try {
  96.             // verify precondition
  97.             if (!is_numeric ($position)) {
  98.                 throw new Gumbo_Exception ("Invalid Argument 'position:int' => {$position}:" . gettype ($position));
  99.             }
  100.             if (!is_string ($data) && !is_numeric ($data) && !is_array ($data)) {
  101.                 throw new Gumbo_Exception ("Invalid Argument 'data:num|str|arr' => {$data}:" . gettype ($data));
  102.             }
  103.             $position = (int) $position;
  104.             
  105.             // loading extra arguments
  106.             if (func_num_args () > 2) {
  107.                 $data = array ();
  108.                 foreach (func_get_args () as $key=>$val) {
  109.                     if ($key == 0) { continue; }
  110.                     $data [] = $val;
  111.                 }
  112.             }
  113.             
  114.             // adds to the end if position is out of range
  115.             if ($position < 0 || $position > count ($this->getElements ())) {
  116.                 $this->add ($data);
  117.                 return;
  118.             }
  119.             
  120.             // recursize method call
  121.             if (is_array ($data)) {
  122.                 foreach ($data as $val) {
  123.                     $this->place ($position, $val);
  124.                     $position++;
  125.                 }
  126.                 return;
  127.             }
  128.             
  129.             // place the data in the right position
  130.             $tmp = $this->getElements ();
  131.             $this->_elements = array ();
  132.             foreach ($tmp as $key=>$val) {
  133.                 if ($position == $key+1) {
  134.                     $this->_elements [] = $data;
  135.                 }
  136.                 $this->_elements [] = $val;
  137.             }
  138.         } catch (Gumbo_Exception $e) {
  139.             $e->setFunction (__METHOD__);
  140.             gumbo_trigger ($e);
  141.         }
  142.     }
  143.     
  144. }
  145.  
  146. ?>