Source for file Array.php

Documentation is available at Array.php

  1. <?php
  2. /**
  3.  * This file contains the class XML_Query2XML_Driver_Array.
  4.  *
  5.  * PHP version 5
  6.  *
  7.  * @category  XML
  8.  * @package   XML_Query2XML
  9.  * @author    Lukas Feiler <lukas.feiler@lukasfeiler.com>
  10.  * @copyright 2008 Lukas Feiler
  11.  * @license   http://www.gnu.org/copyleft/lesser.html  LGPL Version 2.1
  12.  * @version   CVS: $Id: Array.php 259514 2008-05-10 21:04:44Z lukasfeiler $
  13.  * @link      http://pear.php.net/package/XML_Query2XML
  14.  */
  15.  
  16. /**
  17.  * XML_Query2XML_Driver_Array extends XML_Query2XML_Driver.
  18.  */
  19. require_once 'XML/Query2XML.php';
  20.  
  21. /**
  22.  * Array-based driver.
  23.  *
  24.  * usage:
  25.  * <code>
  26.  * $arrayDriver = XML_Query2XML_Driver_Array::factory();
  27.  * $arrayDriver->addResultSet(
  28.  *  'RESULT_SET_NAME', // to be used for $sql or $options['sql']
  29.  *  array(
  30.  *    array('column' => 'value', ...), // record #1
  31.  *    array('column' => 'value', ...)  // record #2
  32.  *  )
  33.  * );
  34.  * </code>
  35.  * Usage scenario:
  36.  * - Transform an array of associative arrays to XML:
  37.  *   $query2xml->getFlatXML('RESULT_SET_ARTISTS_FLAT');
  38.  * - Transform an array of index arrays to XML:
  39.  *   $dom = $query2xml->getXML(
  40.  *       'RESULT_SET_ARTISTS_FLAT',
  41.  *       array(
  42.  *          'rootTag' => 'data',
  43.  *          'rowTag' => 'row',
  44.  *          'idColumn' => false,
  45.  *          'elements' => array(
  46.  *              'name' => '0',
  47.  *              'ID' => '1',
  48.  *              'info' => '2'
  49.  *          )
  50.  *       )
  51.  *   );
  52.  * - Easy integration of other data sources without having
  53.  *   to write a separate driver.
  54.  * - Easy lookup table for static data. $options['sql']['data']
  55.  *   can be used to specify the matching record.
  56.  *
  57.  * @category  XML
  58.  * @package   XML_Query2XML
  59.  * @author    Lukas Feiler <lukas.feiler@lukasfeiler.com>
  60.  * @copyright 2008 Lukas Feiler
  61.  * @license   http://www.gnu.org/copyleft/lesser.html  LGPL Version 2.1
  62.  * @version   Release: @package_version@
  63.  * @link      http://pear.php.net/package/XML_Query2XML
  64.  * @since     Release 1.8.0RC1
  65.  */
  66. class XML_Query2XML_Driver_Array extends XML_Query2XML_Driver
  67. {
  68.     /**
  69.      * An associative array of result sets.
  70.      * @var array An associative array.
  71.      */
  72.     private $_resultSets = null;
  73.     
  74.     /**
  75.      * Add a named result set.
  76.      *
  77.      * @param string $name      The name of the result set.
  78.      * @param array  $resultSet An indexed array of associative arrays.
  79.      *
  80.      * @return void 
  81.      */
  82.     public function addResultSet($name, array $resultSet)
  83.     {
  84.         $this->_resultSets[$name] = $resultSet;
  85.     }
  86.     
  87.     /**
  88. /**
  89.      * Remove a named result set.
  90.      *
  91.      * @param string $name The name of the result set to remove
  92.      *
  93.      * @return void 
  94.      */
  95.     public function removeResultSet($name)
  96.     {
  97.         unset($this->_resultSets[$name]);
  98.     }
  99.     
  100.     /**
  101.      * Factory method
  102.      *
  103.      * @param array  $resultSet     An index array of associative arrays.
  104.      *                               This argument is optional.
  105.      * @param string $resultSetName The name of the result set. This argument
  106.      *                               is optional. The default is an empty string.
  107.      *
  108.      * @return XML_Query2XML_Driver_Array 
  109.      */
  110.     public static function factory(array $resultSet = null, $resultSetName = '')
  111.     {
  112.         $driver = new XML_Query2XML_Driver_Array();
  113.         if (is_array($resultSet)) {
  114.             $driver->addResultSet($resultSetName, $resultSet);
  115.         }
  116.         return $driver;
  117.     }
  118.     
  119.     /**
  120.      * Returns all records from a named result set.
  121.      *
  122.      * @param array  $query      An array with at least one element: 'query'.
  123.      * @param string $configPath The configuration path.
  124.      *
  125.      * @return array An index array of associative arrays.
  126.      */
  127.     public function getAllRecords($query, $configPath)
  128.     {
  129.         $resultSetName = $query['query'];
  130.         if (!isset($this->_resultSets[$resultSetName])) {
  131.             throw new XML_Query2XML_ArrayException(
  132.                 $configPath . ': the result set "' . $resultSetName . '" '
  133.                 . 'does not exist'
  134.             );
  135.         }
  136.         $resultSet = $this->_resultSets[$resultSetName];
  137.         if (array_key_exists('data', $query)) {
  138.             /*
  139.              * Only return records that have a corresponding
  140.              * column for each element key of $query['data']
  141.              * and have the same column value as the array
  142.              * element.
  143.              */
  144.             $filteredResultSet = array();
  145.             for ($i = 0; $i < count($resultSet); $i++) {
  146.                 $include = true;
  147.                 foreach ($query['data'] as $key => $value) {
  148.                     if (array_key_exists($key, $resultSet[$i])) {
  149.                         if ($resultSet[$i][$key] != $value) {
  150.                             $include = false;
  151.                             break;
  152.                         }
  153.                     } else {
  154.                         $include = false;
  155.                     }
  156.                 }
  157.                 if ($include) {
  158.                     $filteredResultSet[] = $resultSet[$i];
  159.                 }
  160.             }
  161.             $resultSet = $filteredResultSet;
  162.         }
  163.         
  164.         return $resultSet;
  165.     }
  166. }
  167.  
  168. /**
  169.  * Exception for errors related to the array driver.
  170.  *
  171.  * @category XML
  172.  * @package  XML_Query2XML
  173.  * @author   Lukas Feiler <lukas.feiler@lukasfeiler.com>
  174.  * @license  http://www.gnu.org/copyleft/lesser.html  LGPL Version 2.1
  175.  * @link     http://pear.php.net/package/XML_Query2XML
  176.  * @since    Release 1.8.0RC1
  177.  */
  178. class XML_Query2XML_ArrayException extends XML_Query2XML_DriverException
  179. {
  180.     /**
  181.      * Constructor
  182.      *
  183.      * @param string $message The error message.
  184.      */
  185.     public function __construct($message)
  186.     {
  187.         parent::__construct($message);
  188.     }
  189. }
  190. ?>

Documentation generated on Sun, 03 Apr 2011 13:13:07 +0200 by phpDocumentor 1.4.1