tests/PHPUnit/Extensions/Database/DB/MetaData/InformationSchema.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 require_once 'PHPUnit/Extensions/Database/DB/MetaData.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Provides functionality to retrieve meta data from a database with information_schema support.
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Mike Lively <m@digitalsandwich.com>
  59  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  61  * @version    Release: 3.3.17
  62  * @link       http://www.phpunit.de/
  63  * @since      Class available since Release 3.2.0
  64  */
  65 class PHPUnit_Extensions_Database_DB_MetaData_InformationSchema extends PHPUnit_Extensions_Database_DB_MetaData
  66 {
  67
  68     protected $columns = array();
  69
  70     protected $keys = array();
  71
  72     /**
  73      * Returns an array containing the names of all the tables in the database.
  74      *
  75      * @return array
  76      */
  77     public function getTableNames()
  78     {
  79         $query = "
  80             SELECT DISTINCT
  81                 TABLE_NAME
  82             FROM INFORMATION_SCHEMA.TABLES
  83             WHERE
  84                 TABLE_TYPE='BASE TABLE' AND
  85                 TABLE_SCHEMA = ?
  86             ORDER BY TABLE_NAME
  87         ";
  88
  89         $statement = $this->pdo->prepare($query);
  90         $statement->execute(array($this->getSchema()));
  91
  92         $tableNames = array();
  93         while ($tableName = $statement->fetchColumn(0)) {
  94             $tableNames[] = $tableName;
  95         }
  96
  97         return $tableNames;
  98     }
  99
 100     /**
 101      * Returns an array containing the names of all the columns in the
 102      * $tableName table,
 103      *
 104      * @param string $tableName
 105      * @return array
 106      */
 107     public function getTableColumns($tableName)
 108     {
 109         if (!isset($this->columns[$tableName])) {
 110             $this->loadColumnInfo($tableName);
 111         }
 112
 113         return $this->columns[$tableName];
 114     }
 115
 116     /**
 117      * Returns an array containing the names of all the primary key columns in
 118      * the $tableName table.
 119      *
 120      * @param string $tableName
 121      * @return array
 122      */
 123     public function getTablePrimaryKeys($tableName)
 124     {
 125         if (!isset($this->keys[$tableName])) {
 126             $this->loadColumnInfo($tableName);
 127         }
 128
 129         return $this->keys[$tableName];
 130     }
 131
 132     /**
 133      * Loads column info from a sqlite database.
 134      *
 135      * @param string $tableName
 136      */
 137     protected function loadColumnInfo($tableName)
 138     {
 139         $this->columns[$tableName] = array();
 140         $this->keys[$tableName] = array();
 141
 142         $columnQuery = "
 143             SELECT DISTINCT
 144                 COLUMN_NAME
 145             FROM INFORMATION_SCHEMA.COLUMNS
 146             WHERE
 147                 TABLE_NAME = ? AND
 148                 TABLE_SCHEMA = ?
 149             ORDER BY ORDINAL_POSITION
 150         ";
 151
 152         $columnStatement = $this->pdo->prepare($columnQuery);
 153         $columnStatement->execute(array($tableName, $this->getSchema()));
 154
 155         while ($columName = $columnStatement->fetchColumn(0)) {
 156             $this->columns[$tableName][] = $columName;
 157         }
 158
 159         $keyQuery = "
 160                         SELECT
 161                                 KCU.COLUMN_NAME
 162                         FROM
 163                                 INFORMATION_SCHEMA.TABLE_CONSTRAINTS as TC,
 164                                 INFORMATION_SCHEMA.KEY_COLUMN_USAGE as KCU
 165                         WHERE
 166                                 TC.CONSTRAINT_NAME = KCU.CONSTRAINT_NAME AND
 167                                 TC.TABLE_NAME = KCU.TABLE_NAME AND
 168                                 TC.TABLE_SCHEMA = KCU.TABLE_SCHEMA AND
 169                                 TC.CONSTRAINT_TYPE = 'PRIMARY KEY' AND
 170                                 TC.TABLE_NAME = ? AND
 171                                 TC.TABLE_SCHEMA = ?
 172                         ORDER BY
 173                                 KCU.ORDINAL_POSITION ASC
 174         ";
 175
 176         $keyStatement = $this->pdo->prepare($keyQuery);
 177         $keyStatement->execute(array($tableName, $this->getSchema()));
 178
 179         while ($columName = $keyStatement->fetchColumn(0)) {
 180             $this->keys[$tableName][] = $columName;
 181         }
 182     }
 183 }
 184 ?>