tests/PHPUnit/Extensions/Database/DataSet/AbstractXmlDataSet.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Mike Lively <m@digitalsandwich.com>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 require_once 'PHPUnit/Extensions/Database/DataSet/AbstractDataSet.php';
  51 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableIterator.php';
  52 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableMetaData.php';
  53 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTable.php';
  54
  55 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  56
  57 /**
  58  * The default implementation of a data set.
  59  *
  60  * @category   Testing
  61  * @package    PHPUnit
  62  * @author     Mike Lively <m@digitalsandwich.com>
  63  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  64  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  65  * @version    Release: 3.3.17
  66  * @link       http://www.phpunit.de/
  67  * @since      Class available since Release 3.2.0
  68  */
  69 abstract class PHPUnit_Extensions_Database_DataSet_AbstractXmlDataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
  70 {
  71
  72     /**
  73      * @var array
  74      */
  75     protected $tables;
  76
  77     /**
  78      * @var SimpleXmlElement
  79      */
  80     protected $xmlFileContents;
  81
  82     /**
  83      * Creates a new dataset using the given tables.
  84      *
  85      * @param array $tables
  86      */
  87     public function __construct($xmlFile)
  88     {
  89         if (!is_file($xmlFile)) {
  90             throw new InvalidArgumentException("Could not find xml file: {$xmlFile}");
  91         }
  92         $this->xmlFileContents = @simplexml_load_file($xmlFile);
  93
  94         if ($this->xmlFileContents === FALSE) {
  95             throw new InvalidArgumentException("File is not valid xml: {$xmlFile}");
  96         }
  97
  98         $tableColumns = array();
  99         $tableValues = array();
 100
 101         $this->getTableInfo($tableColumns, $tableValues);
 102         $this->createTables($tableColumns, $tableValues);
 103     }
 104
 105     /**
 106      * Reads the simple xml object and creates the appropriate tables and meta
 107      * data for this dataset.
 108      */
 109     protected abstract function getTableInfo(Array &$tableColumns, Array &$tableValues);
 110
 111     protected function createTables(Array &$tableColumns, Array &$tableValues)
 112     {
 113         foreach ($tableValues as $tableName => $values) {
 114             $table = $this->getOrCreateTable($tableName, $tableColumns[$tableName]);
 115             foreach ($values as $value) {
 116                 $table->addRow($value);
 117             }
 118         }
 119     }
 120
 121     /**
 122      * Returns the table with the matching name. If the table does not exist
 123      * an empty one is created.
 124      *
 125      * @param string $tableName
 126      * @return PHPUnit_Extensions_Database_DataSet_ITable
 127      */
 128     protected function getOrCreateTable($tableName, $tableColumns)
 129     {
 130         if (empty($this->tables[$tableName])) {
 131             $tableMetaData = new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $tableColumns);
 132             $this->tables[$tableName] = new PHPUnit_Extensions_Database_DataSet_DefaultTable($tableMetaData);
 133         }
 134
 135         return $this->tables[$tableName];
 136     }
 137
 138     /**
 139      * Creates an iterator over the tables in the data set. If $reverse is
 140      * true a reverse iterator will be returned.
 141      *
 142      * @param bool $reverse
 143      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 144      */
 145     protected function createIterator($reverse = FALSE)
 146     {
 147         return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($this->tables, $reverse);
 148     }
 149 }
 150 ?>