tests/PHPUnit/Extensions/Database/DB/IMetaData.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 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 /**
  53  * Provides a basic interface for retreiving metadata from a database.
  54  *
  55  * @category   Testing
  56  * @package    PHPUnit
  57  * @author     Mike Lively <m@digitalsandwich.com>
  58  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  59  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  60  * @version    Release: 3.3.17
  61  * @link       http://www.phpunit.de/
  62  * @since      Class available since Release 3.2.0
  63  */
  64 interface PHPUnit_Extensions_Database_DB_IMetaData
  65 {
  66
  67     /**
  68      * Returns an array containing the names of all the tables in the database.
  69      *
  70      * @return array
  71      */
  72     public function getTableNames();
  73
  74     /**
  75      * Returns an array containing the names of all the columns in the
  76      * $tableName table,
  77      *
  78      * @param string $tableName
  79      * @return array
  80      */
  81     public function getTableColumns($tableName);
  82
  83     /**
  84      * Returns an array containing the names of all the primary key columns in
  85      * the $tableName table.
  86      *
  87      * @param string $tableName
  88      * @return array
  89      */
  90     public function getTablePrimaryKeys($tableName);
  91
  92     /**
  93      * Returns the name of the default schema.
  94      *
  95      * @return string
  96      */
  97     public function getSchema();
  98
  99     /**
 100      * Returns a quoted schema object. (table name, column name, etc)
 101      *
 102      * @param string $object
 103      * @return string
 104      */
 105     public function quoteSchemaObject($object);
 106
 107     /**
 108      * Returns true if the rdbms allows cascading
 109      *
 110      * @return bool
 111      */
 112     public function allowsCascading();
 113 }
 114 ?>