tests/PHPUnit/Extensions/Database/DataSet/QueryDataSet.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/DataSet/QueryTable.php';
  53 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableIterator.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_DataSet_QueryDataSet 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     public function addTable($tableName, $query = NULL)
  97     {
  98         if ($query === NULL) {
  99             $query = 'SELECT * FROM ' . $tableName;
 100         }
 101
 102         $this->tables[$tableName] = new PHPUnit_Extensions_Database_DataSet_QueryTable($tableName, $query, $this->databaseConnection);
 103     }
 104
 105     /**
 106      * Creates an iterator over the tables in the data set. If $reverse is
 107      * true a reverse iterator will be returned.
 108      *
 109      * @param bool $reverse
 110      * @return PHPUnit_Extensions_Database_DB_TableIterator
 111      */
 112     protected function createIterator($reverse = FALSE)
 113     {
 114         return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($this->tables, $reverse);
 115     }
 116
 117     /**
 118      * Returns a table object for the given table.
 119      *
 120      * @param string $tableName
 121      * @return PHPUnit_Extensions_Database_DB_Table
 122      */
 123     public function getTable($tableName)
 124     {
 125         if (!isset($this->tables[$tableName])) {
 126             throw new InvalidArgumentException("$tableName is not a table in the current database.");
 127         }
 128
 129         return $this->tables[$tableName];
 130     }
 131
 132     /**
 133      * Returns a list of table names for the database
 134      *
 135      * @return Array
 136      */
 137     public function getTableNames()
 138     {
 139         return array_keys($this->tables);
 140     }
 141 }
 142 ?>