tests/PHPUnit/Extensions/Database/DataSet/AbstractDataSet.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/IDataSet.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Implements the basic functionality of data sets.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.2.0
  65  */
  66 abstract class PHPUnit_Extensions_Database_DataSet_AbstractDataSet implements PHPUnit_Extensions_Database_DataSet_IDataSet
  67 {
  68
  69     /**
  70      * Creates an iterator over the tables in the data set. If $reverse is
  71      * true a reverse iterator will be returned.
  72      *
  73      * @param bool $reverse
  74      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
  75      */
  76     protected abstract function createIterator($reverse = FALSE);
  77
  78     /**
  79      * Returns an array of table names contained in the dataset.
  80      *
  81      * @return array
  82      */
  83     public function getTableNames()
  84     {
  85         $tableNames = array();
  86
  87         foreach ($this->getIterator() as $table) {
  88             /* @var $table PHPUnit_Extensions_Database_DataSet_ITable */
  89             $tableNames[] = $table->getTableMetaData()->getTableName();
  90         }
  91
  92         return $tableNames;
  93     }
  94
  95     /**
  96      * Returns a table meta data object for the given table.
  97      *
  98      * @param string $tableName
  99      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
 100      */
 101     public function getTableMetaData($tableName)
 102     {
 103         return $this->getTable($tableName)->getTableMetaData();
 104     }
 105
 106     /**
 107      * Returns a table object for the given table.
 108      *
 109      * @param string $tableName
 110      * @return PHPUnit_Extensions_Database_DataSet_ITable
 111      */
 112     public function getTable($tableName)
 113     {
 114         foreach ($this->getIterator() as $table) {
 115             /* @var $table PHPUnit_Extensions_Database_DataSet_ITable */
 116             if ($table->getTableMetaData()->getTableName() == $tableName) {
 117                 return $table;
 118             }
 119         }
 120     }
 121
 122     /**
 123      * Returns an iterator for all table objects in the given dataset.
 124      *
 125      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 126      */
 127     public function getIterator()
 128     {
 129         return $this->createIterator();
 130     }
 131
 132     /**
 133      * Returns a reverse iterator for all table objects in the given dataset.
 134      *
 135      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 136      */
 137     public function getReverseIterator()
 138     {
 139         return $this->createIterator(TRUE);
 140     }
 141
 142     /**
 143      * Asserts that the given data set matches this data set.
 144      *
 145      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $other
 146      */
 147     public function assertEquals(PHPUnit_Extensions_Database_DataSet_IDataSet $other)
 148     {
 149         $thisTableNames = $this->getTableNames();
 150         $otherTableNames = $other->getTableNames();
 151
 152         sort($thisTableNames);
 153         sort($otherTableNames);
 154
 155         if ($thisTableNames != $otherTableNames) {
 156             throw new Exception("Expected following tables: " . implode(', ', $thisTableNames) . "; has columns: " . implode(', ', $otherTableNames));
 157         }
 158
 159         foreach ($thisTableNames as $tableName) {
 160             $this->getTable($tableName)->assertEquals($other->getTable($tableName));
 161         }
 162
 163         return TRUE;
 164     }
 165
 166     public function __toString()
 167     {
 168         $iterator = $this->getIterator();
 169
 170         $dataSetString = '';
 171         foreach ($iterator as $table) {
 172             $dataSetString .= $table->__toString();
 173         }
 174
 175         return $dataSetString;
 176     }
 177 }
 178 ?>