Source for file Array.class.php

Documentation is available at Array.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 Converter
  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.  * Array Converter Class
  22.  *
  23.  * @category Gumbo
  24.  * @package Converter
  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 Array Converter Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Converter_Abstract");
  34.  
  35. class Gumbo_Converter_Array extends Gumbo_Converter_Abstract {
  36.     
  37.     /** ACTION METHODS **/
  38.     /**
  39.      * Returns a Composite
  40.      * @param array $data array data
  41.      * @return Gumbo_Interface_Composite 
  42.      * @throws Gumbo_Exception
  43.      * @uses Gumbo_Branch
  44.      */
  45.     public function toComposite ($data) {
  46.         try {
  47.             // verify precondition
  48.             if (!is_array ($data)) {
  49.                 throw new Gumbo_Exception ("Invalid Argument 'data:arr' => {$data}:" . gettype ($data));
  50.             }
  51.             
  52.             return $this->_getComposite ($data);
  53.         } catch (Gumbo_Exception $e) {
  54.             $e->setFunction (__METHOD__);
  55.             gumbo_trigger ($e);
  56.         }
  57.         return new Gumbo_Branch ();
  58.     }
  59.     
  60.     
  61.     
  62.     /** ACCESSOR METHODS **/
  63.     /**
  64.      * Returns a single Composite object from an array
  65.      * This is a recusive method
  66.      * @param array $data 
  67.      * @param string $name name of the Composite
  68.      * @return Gumbo_Interface_Composite 
  69.      * @throws Gumbo_Exception
  70.      * @uses Gumbo_Interface_Composite
  71.      */
  72.     private function _getComposite ($data, $name=null) {
  73.         try {
  74.             // verify precondition
  75.             if (!is_array ($data)) {
  76.                 throw new Gumbo_Exception ("Invalid Argument 'data:arr' => {$data}:" . gettype ($data));
  77.             }
  78.             try {
  79.                 if (!is_null ($name) && !is_string ($name) && !is_numeric ($name)) {
  80.                     throw new Gumbo_Exception ("Invalid Argument 'name:num|str|null' => {$name}:" . gettype ($name));
  81.                 }
  82.             } catch (Gumbo_Exception $e) {
  83.                 $e->setFunction (__METHOD__);
  84.                 gumbo_trigger ($e);
  85.                 $name = null;
  86.             }
  87.             
  88.             $tree = new Gumbo_Branch ($name);
  89.             
  90.             // loop through the array
  91.             foreach ($data as $key=>$val) {
  92.                 if (is_array ($val)) {
  93.                     $tmp = $this->_getTree ($val, $key);
  94.                     if ($tmp instanceof Gumbo_Interface_Composite) {
  95.                         $tree->add ($tmp);
  96.                     }
  97.                 } else {
  98.                     $tree->add (new Gumbo_Leaf ($key, $val));
  99.                 }
  100.             }
  101.             
  102.             return $tree;
  103.         } catch (Gumbo_Exception $e) {
  104.             $e->getFunction (__METHOD__);
  105.             gumbo_trigger ($e);
  106.         }
  107.         return null;
  108.     }
  109.     
  110. }
  111.  
  112. ?>