tests/PHPUnit/Extensions/Database/DB/DataSet.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/DefaultTableMetaData.php';
  52 require_once 'PHPUnit/Extensions/Database/DB/TableIterator.php';
  53 require_once 'PHPUnit/Extensions/Database/DB/Table.php';
  54
  55 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  56
  57 /**
  58  * Provides access to a database instance as 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 class PHPUnit_Extensions_Database_DB_DataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
  70 {
  71
  72     /**
  73      * An array of ITable objects.
  74      *
  75      * @var array
  76      */
  77     protected $tables = array();
  78
  79     /**
  80      * The database connection this dataset is using.
  81      *
  82      * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
  83      */
  84     protected $databaseConnection;
  85
  86     /**
  87      * Creates a new dataset using the given database connection.
  88      *
  89      * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection
  90      */
  91     public function __construct(PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection)
  92     {
  93         $this->databaseConnection = $databaseConnection;
  94     }
  95
  96     /**
  97      * Creates the query necessary to pull all of the data from a table.
  98      *
  99      * @param PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData
 100      * @return unknown
 101      */
 102     public static function buildTableSelect(PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData)
 103     {
 104         if ($tableMetaData->getTableName() == '') {
 105             $e = new Exception("Empty Table Name");
 106             echo $e->getTraceAsString();
 107             throw $e;
 108         }
 109
 110         $columnList = implode(', ', $tableMetaData->getColumns());
 111
 112         $primaryKeys = $tableMetaData->getPrimaryKeys();
 113         if (count($primaryKeys)) {
 114             $orderBy = 'ORDER BY ' . implode(' ASC, ', $primaryKeys) . ' ASC';
 115         } else {
 116             $orderBy = '';
 117         }
 118
 119         return "SELECT {$columnList} FROM {$tableMetaData->getTableName()} {$orderBy}";
 120     }
 121
 122     /**
 123      * Creates an iterator over the tables in the data set. If $reverse is
 124      * true a reverse iterator will be returned.
 125      *
 126      * @param bool $reverse
 127      * @return PHPUnit_Extensions_Database_DB_TableIterator
 128      */
 129     protected function createIterator($reverse = FALSE)
 130     {
 131         return new PHPUnit_Extensions_Database_DB_TableIterator($this->getTableNames(), $this, $reverse);
 132     }
 133
 134     /**
 135      * Returns a table object for the given table.
 136      *
 137      * @param string $tableName
 138      * @return PHPUnit_Extensions_Database_DB_Table
 139      */
 140     public function getTable($tableName)
 141     {
 142         if (!in_array($tableName, $this->getTableNames())) {
 143             throw new InvalidArgumentException("$tableName is not a table in the current database.");
 144         }
 145
 146         if (empty($this->tables[$tableName])) {
 147             $this->tables[$tableName] = new PHPUnit_Extensions_Database_DB_Table($this->getTableMetaData($tableName), $this->databaseConnection);
 148         }
 149
 150         return $this->tables[$tableName];
 151     }
 152
 153     /**
 154      * Returns a table meta data object for the given table.
 155      *
 156      * @param string $tableName
 157      * @return PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData
 158      */
 159     public function getTableMetaData($tableName)
 160     {
 161         return new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $this->databaseConnection->getMetaData()->getTableColumns($tableName), $this->databaseConnection->getMetaData()->getTablePrimaryKeys($tableName));
 162     }
 163
 164     /**
 165      * Returns a list of table names for the database
 166      *
 167      * @return Array
 168      */
 169     public function getTableNames()
 170     {
 171         return $this->databaseConnection->getMetaData()->getTableNames();
 172     }
 173 }
 174 ?>