tests/PHPUnit/Extensions/Database/DataSet/DefaultTableIterator.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 require_once 'PHPUnit/Extensions/Database/DataSet/ITableIterator.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * The default table iterator
  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 class PHPUnit_Extensions_Database_DataSet_DefaultTableIterator implements PHPUnit_Extensions_Database_DataSet_ITableIterator
  67 {
  68
  69     /**
  70      * An array of tables in the iterator.
  71      *
  72      * @var Array
  73      */
  74     protected $tables;
  75
  76     /**
  77      * If this property is true then the tables will be iterated in reverse
  78      * order.
  79      *
  80      * @var bool
  81      */
  82     protected $reverse;
  83
  84     /**
  85      * Creates a new default table iterator object.
  86      *
  87      * @param array $tables
  88      * @param bool $reverse
  89      */
  90     public function __construct(Array $tables, $reverse = FALSE)
  91     {
  92         $this->tables = $tables;
  93         $this->reverse = $reverse;
  94
  95         $this->rewind();
  96     }
  97
  98     /**
  99      * Returns the current table.
 100      *
 101      * @return PHPUnit_Extensions_Database_DataSet_ITable
 102      */
 103     public function getTable()
 104     {
 105         $this->current();
 106     }
 107
 108     /**
 109      * Returns the current table's meta data.
 110      *
 111      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
 112      */
 113     public function getTableMetaData()
 114     {
 115         $this->current()->getTableMetaData();
 116     }
 117
 118     /**
 119      * Returns the current table.
 120      *
 121      * @return PHPUnit_Extensions_Database_DataSet_ITable
 122      */
 123     public function current()
 124     {
 125         return current($this->tables);
 126     }
 127
 128     /**
 129      * Returns the name of the current table.
 130      *
 131      * @return string
 132      */
 133     public function key()
 134     {
 135         return $this->current()->getTableMetaData()->getTableName();
 136     }
 137
 138     /**
 139      * advances to the next element.
 140      *
 141      */
 142     public function next()
 143     {
 144         if ($this->reverse) {
 145             prev($this->tables);
 146         } else {
 147             next($this->tables);
 148         }
 149     }
 150
 151     /**
 152      * Rewinds to the first element
 153      */
 154     public function rewind()
 155     {
 156         if ($this->reverse) {
 157             end($this->tables);
 158         } else {
 159             reset($this->tables);
 160         }
 161     }
 162
 163     /**
 164      * Returns true if the current index is valid
 165      *
 166      * @return bool
 167      */
 168     public function valid()
 169     {
 170         return ($this->current() !== FALSE);
 171     }
 172 }
 173 ?>