tests/PHPUnit/Extensions/Database/DB/IDatabaseConnection.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 communicating with 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_IDatabaseConnection
  65 {
  66
  67     /**
  68      * Close this connection.
  69      */
  70     public function close();
  71
  72     /**
  73      * Creates a dataset containing the specified table names. If no table
  74      * names are specified then it will created a dataset over the entire
  75      * database.
  76      *
  77      * @param array $tableNames
  78      * @return PHPUnit_Extensions_Database_DataSet_IDataSet
  79      */
  80     public function createDataSet(Array $tableNames = NULL);
  81
  82     /**
  83      * Creates a table with the result of the specified SQL statement.
  84      *
  85      * @param string $resultName
  86      * @param string $sql
  87      * @return PHPUnit_Extensions_Database_DataSet_ITable
  88      */
  89     public function createQueryTable($resultName, $sql);
  90
  91     /**
  92      * Returns a PDO Connection
  93      *
  94      * @return PDO
  95      */
  96     public function getConnection();
  97
  98     /**
  99      * Returns a database metadata object that can be used to retrieve table
 100      * meta data from the database.
 101      *
 102      * @return PHPUnit_Extensions_Database_DB_IMetaData
 103      */
 104     public function getMetaData();
 105
 106     /**
 107      * Returns the number of rows in the given table. You can specify an
 108      * optional where clause to return a subset of the table.
 109      *
 110      * @param string $tableName
 111      * @param string $whereClause
 112      * @param int
 113      */
 114     public function getRowCount($tableName, $whereClause = NULL);
 115
 116     /**
 117      * Returns the schema for the connection.
 118      *
 119      * @return string
 120      */
 121     public function getSchema();
 122
 123     /**
 124      * Returns a quoted schema object. (table name, column name, etc)
 125      *
 126      * @param string $object
 127      * @return string
 128      */
 129     public function quoteSchemaObject($object);
 130
 131     /**
 132      * Returns the command used to truncate a table.
 133      *
 134      * @return string
 135      */
 136     public function getTruncateCommand();
 137
 138     /**
 139      * Returns true if the connection allows cascading
 140      *
 141      * @return bool
 142      */
 143     public function allowsCascading();
 144 }
 145 ?>