tests/PHPUnit/Extensions/Database/DataSet/CompositeDataSet.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/Util/Filter.php';
  48
  49 require_once 'PHPUnit/Extensions/Database/DataSet/AbstractDataSet.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Creates Composite Datasets
  55  *
  56  * Allows for creating datasets from multiple sources (csv, query, xml, etc.)
  57  *
  58  * @category   Testing
  59  * @package    PHPUnit
  60  * @author     Mike Lively <m@digitalsandwich.com>
  61  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  62  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  63  * @version    Release: 3.3.17
  64  * @link       http://www.phpunit.de/
  65  * @since      Class available since Release 3.3.0
  66  */
  67 class PHPUnit_Extensions_Database_DataSet_CompositeDataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
  68 {
  69     protected $dataSets = array();
  70
  71     /**
  72      * Creates a new Composite dataset
  73      *
  74      * You can pass in any data set that implements PHPUnit_Extensions_Database_DataSet_IDataSet
  75      *
  76      * @param string $delimiter
  77      * @param string $enclosure
  78      * @param string $escape
  79      */
  80     public function __construct(Array $dataSets)
  81     {
  82         foreach ($dataSets as $dataSet)
  83         {
  84             $this->addDataSet($dataSet);
  85         }
  86     }
  87
  88     /**
  89      * Adds a new data set to the composite.
  90      *
  91      * The dataset may not define tables that already exist in the composite.
  92      *
  93      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet
  94      */
  95     public function addDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet)
  96     {
  97         foreach ($dataSet->getTableNames() as $tableName)
  98         {
  99             if (in_array($tableName, $this->getTableNames()))
 100             {
 101                 throw new InvalidArgumentException("DataSet contains a table that already exists: {$tableName}");
 102             }
 103         }
 104
 105         $this->dataSets[] = $dataSet;
 106     }
 107
 108     /**
 109      * Creates an iterator over the tables in the data set. If $reverse is
 110      * true a reverse iterator will be returned.
 111      *
 112      * @param bool $reverse
 113      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 114      */
 115     protected function createIterator($reverse = FALSE)
 116     {
 117         $iterator = new AppendIterator();
 118
 119         $dataSets = $reverse ? array_reverse($this->dataSets) : $this->dataSets;
 120
 121         foreach ($dataSets as $dataSet)
 122         {
 123             /* @var $dataSet PHPUnit_Extensions_Database_DataSet_IDataSet */
 124             $dataSetIterator = $reverse ? $dataSet->getReverseIterator() : $dataSet->getIterator();
 125             $iterator->append($dataSetIterator);
 126         }
 127         return $iterator;
 128     }
 129 }
 130 ?>