5 * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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
43 * @link http://www.phpunit.de/
44 * @since File available since Release 3.2.0
47 require_once 'PHPUnit/Framework.php';
48 require_once 'PHPUnit/Util/Filter.php';
50 require_once 'PHPUnit/Extensions/Database/DataSet/ITableIterator.php';
52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
55 * The default table iterator
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
66 class PHPUnit_Extensions_Database_DataSet_DefaultTableIterator implements PHPUnit_Extensions_Database_DataSet_ITableIterator
70 * An array of tables in the iterator.
77 * If this property is true then the tables will be iterated in reverse
85 * Creates a new default table iterator object.
87 * @param array $tables
88 * @param bool $reverse
90 public function __construct(Array $tables, $reverse = FALSE)
92 $this->tables = $tables;
93 $this->reverse = $reverse;
99 * Returns the current table.
101 * @return PHPUnit_Extensions_Database_DataSet_ITable
103 public function getTable()
109 * Returns the current table's meta data.
111 * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
113 public function getTableMetaData()
115 $this->current()->getTableMetaData();
119 * Returns the current table.
121 * @return PHPUnit_Extensions_Database_DataSet_ITable
123 public function current()
125 return current($this->tables);
129 * Returns the name of the current table.
133 public function key()
135 return $this->current()->getTableMetaData()->getTableName();
139 * advances to the next element.
142 public function next()
144 if ($this->reverse) {
152 * Rewinds to the first element
154 public function rewind()
156 if ($this->reverse) {
159 reset($this->tables);
164 * Returns true if the current index is valid
168 public function valid()
170 return ($this->current() !== FALSE);