tests/PHPUnit/Extensions/Database/ITester.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  * This is the interface for DatabaseTester objects. These objects are used to
  54  * add database testing to existing test cases using composition instead of
  55  * extension.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.2.0
  65  */
  66 interface PHPUnit_Extensions_Database_ITester
  67 {
  68
  69     /**
  70      * Closes the specified connection.
  71      *
  72      * @param PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection
  73      */
  74     public function closeConnection(PHPUnit_Extensions_Database_DB_IDatabaseConnection $connection);
  75
  76     /**
  77      * Returns the test database connection.
  78      *
  79      * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
  80      */
  81     public function getConnection();
  82
  83     /**
  84      * Returns the test dataset.
  85      *
  86      * @return PHPUnit_Extensions_Database_DataSet_IDataSet
  87      */
  88     public function getDataSet();
  89
  90     /**
  91      * TestCases must call this method inside setUp().
  92      */
  93     public function onSetUp();
  94
  95     /**
  96      * TestCases must call this method inside teadDown().
  97      */
  98     public function onTearDown();
  99
 100     /**
 101      * Sets the test dataset to use.
 102      *
 103      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet
 104      */
 105     public function setDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataSet);
 106
 107     /**
 108      * Sets the schema value.
 109      *
 110      * @param string $schema
 111      */
 112     public function setSchema($schema);
 113
 114     /**
 115      * Sets the DatabaseOperation to call when starting the test.
 116      *
 117      * @param PHPUnit_Extensions_Database_Operation_DatabaseOperation $setUpOperation
 118      */
 119     public function setSetUpOperation(PHPUnit_Extensions_Database_Operation_IDatabaseOperation $setUpOperation);
 120
 121     /**
 122      * Sets the DatabaseOperation to call when starting the test.
 123      *
 124      * @param PHPUnit_Extensions_Database_Operation_DatabaseOperation $tearDownOperation
 125      */
 126     public function setTearDownOperation(PHPUnit_Extensions_Database_Operation_IDatabaseOperation $tearDownOperation);
 127 }
 128 ?>