tests/PHPUnit/Extensions/Database/DataSet/QueryTable.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/AbstractTable.php';
  51 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableMetaData.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * Provides the functionality to represent a database table.
  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.2.0
  66  */
  67 class PHPUnit_Extensions_Database_DataSet_QueryTable extends PHPUnit_Extensions_Database_DataSet_AbstractTable
  68 {
  69     /**
  70      * @var string
  71      */
  72     protected $query;
  73
  74     /**
  75      * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
  76      */
  77     protected $databaseConnection;
  78
  79     /**
  80      * @var string
  81      */
  82     protected $tableName;
  83
  84     /**
  85      * Creates a new database query table object.
  86      *
  87      * @param string $table_name
  88      * @param string $query
  89      * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection
  90      */
  91     public function __construct($tableName, $query, PHPUnit_Extensions_Database_DB_IDatabaseConnection $databaseConnection)
  92     {
  93         $this->query = $query;
  94         $this->databaseConnection = $databaseConnection;
  95         $this->tableName = $tableName;
  96     }
  97
  98     /**
  99      * Returns the table's meta data.
 100      *
 101      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
 102      */
 103     public function getTableMetaData()
 104     {
 105         $this->createTableMetaData();
 106         return parent::getTableMetaData();
 107     }
 108
 109     /**
 110      * Returns the number of rows in this table.
 111      *
 112      * @return int
 113      */
 114     public function getRowCount()
 115     {
 116         $this->loadData();
 117         return parent::getRowCount();
 118     }
 119
 120     /**
 121      * Returns the value for the given column on the given row.
 122      *
 123      * @param int $row
 124      * @param int $column
 125      */
 126     public function getValue($row, $column)
 127     {
 128         $this->loadData();
 129         return parent::getValue($row, $column);
 130     }
 131
 132     /**
 133      * Returns the an associative array keyed by columns for the given row.
 134      *
 135      * @param int $row
 136      * @return array
 137      */
 138     public function getRow($row)
 139     {
 140         $this->loadData();
 141         return parent::getRow($row);
 142     }
 143
 144     /**
 145      * Asserts that the given table matches this table.
 146      *
 147      * @param PHPUnit_Extensions_Database_DataSet_ITable $other
 148      */
 149     public function assertEquals(PHPUnit_Extensions_Database_DataSet_ITable $other)
 150     {
 151         $this->loadData();
 152         return parent::assertEquals($other);
 153     }
 154
 155     protected function loadData()
 156     {
 157         if ($this->data === NULL) {
 158             $pdoStatement = $this->databaseConnection->getConnection()->query($this->query);
 159             $this->data = $pdoStatement->fetchAll(PDO::FETCH_ASSOC);
 160         }
 161     }
 162
 163     protected function createTableMetaData()
 164     {
 165         if ($this->tableMetaData === NULL)
 166         {
 167             $this->loadData();
 168             $this->tableMetaData = new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($this->tableName, array_keys($this->data[0]));
 169         }
 170     }
 171 }
 172 ?>