5 * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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
43 * @link http://www.phpunit.de/
44 * @since File available since Release 3.2.0
47 require_once 'PHPUnit/Framework.php';
48 require_once 'PHPUnit/Util/Filter.php';
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';
55 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
58 * Provides access to a database instance as a data set.
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
69 class PHPUnit_Extensions_Database_DB_DataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
73 * An array of ITable objects.
77 protected $tables = array();
80 * The database connection this dataset is using.
82 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
84 protected $databaseConnection;
87 * Creates a new dataset using the given database connection.
89 * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection
91 public function __construct(PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection)
93 $this->databaseConnection = $databaseConnection;
97 * Creates the query necessary to pull all of the data from a table.
99 * @param PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData
102 public static function buildTableSelect(PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData)
104 if ($tableMetaData->getTableName() == '') {
105 $e = new Exception("Empty Table Name");
106 echo $e->getTraceAsString();
110 $columnList = implode(', ', $tableMetaData->getColumns());
112 $primaryKeys = $tableMetaData->getPrimaryKeys();
113 if (count($primaryKeys)) {
114 $orderBy = 'ORDER BY ' . implode(' ASC, ', $primaryKeys) . ' ASC';
119 return "SELECT {$columnList} FROM {$tableMetaData->getTableName()} {$orderBy}";
123 * Creates an iterator over the tables in the data set. If $reverse is
124 * true a reverse iterator will be returned.
126 * @param bool $reverse
127 * @return PHPUnit_Extensions_Database_DB_TableIterator
129 protected function createIterator($reverse = FALSE)
131 return new PHPUnit_Extensions_Database_DB_TableIterator($this->getTableNames(), $this, $reverse);
135 * Returns a table object for the given table.
137 * @param string $tableName
138 * @return PHPUnit_Extensions_Database_DB_Table
140 public function getTable($tableName)
142 if (!in_array($tableName, $this->getTableNames())) {
143 throw new InvalidArgumentException("$tableName is not a table in the current database.");
146 if (empty($this->tables[$tableName])) {
147 $this->tables[$tableName] = new PHPUnit_Extensions_Database_DB_Table($this->getTableMetaData($tableName), $this->databaseConnection);
150 return $this->tables[$tableName];
154 * Returns a table meta data object for the given table.
156 * @param string $tableName
157 * @return PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData
159 public function getTableMetaData($tableName)
161 return new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $this->databaseConnection->getMetaData()->getTableColumns($tableName), $this->databaseConnection->getMetaData()->getTablePrimaryKeys($tableName));
165 * Returns a list of table names for the database
169 public function getTableNames()
171 return $this->databaseConnection->getMetaData()->getTableNames();