tests/PHPUnit/Extensions/Database/DataSet/IDataSet.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 creating and reading data from data sets.
  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_DataSet_IDataSet extends IteratorAggregate
  65 {
  66
  67     /**
  68      * Returns an array of table names contained in the dataset.
  69      *
  70      * @return array
  71      */
  72     public function getTableNames();
  73
  74     /**
  75      * Returns a table meta data object for the given table.
  76      *
  77      * @param string $tableName
  78      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
  79      */
  80     public function getTableMetaData($tableName);
  81
  82     /**
  83      * Returns a table object for the given table.
  84      *
  85      * @param string $tableName
  86      * @return PHPUnit_Extensions_Database_DataSet_ITable
  87      */
  88     public function getTable($tableName);
  89
  90     /**
  91      * Returns a reverse iterator for all table objects in the given dataset.
  92      *
  93      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
  94      */
  95     public function getReverseIterator();
  96
  97     /**
  98      * Asserts that the given data set matches this data set.
  99      *
 100      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $other
 101      */
 102     public function assertEquals(PHPUnit_Extensions_Database_DataSet_IDataSet $other);
 103 }
 104 ?>