tests/PHPUnit/Extensions/Database/DB/TableIterator.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  * Provides iterative access to tables from a database instance.
  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_DB_TableIterator implements PHPUnit_Extensions_Database_DataSet_ITableIterator
  67 {
  68
  69     /**
  70      * An array of tablenames.
  71      *
  72      * @var Array
  73      */
  74     protected $tableNames;
  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      * The database dataset that this iterator iterates over.
  86      *
  87      * @var PHPUnit_Extensions_Database_DB_DataSet
  88      */
  89     protected $dataSet;
  90
  91     public function __construct($tableNames, PHPUnit_Extensions_Database_DB_DataSet $dataSet, $reverse = FALSE)
  92     {
  93         $this->tableNames = $tableNames;
  94         $this->dataSet = $dataSet;
  95         $this->reverse = $reverse;
  96
  97         $this->rewind();
  98     }
  99
 100     /**
 101      * Returns the current table.
 102      *
 103      * @return PHPUnit_Extensions_Database_DataSet_ITable
 104      */
 105     public function getTable()
 106     {
 107         return $this->current();
 108     }
 109
 110     /**
 111      * Returns the current table's meta data.
 112      *
 113      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
 114      */
 115     public function getTableMetaData()
 116     {
 117         return $this->current()->getTableMetaData();
 118     }
 119
 120     /**
 121      * Returns the current table.
 122      *
 123      * @return PHPUnit_Extensions_Database_DataSet_ITable
 124      */
 125     public function current()
 126     {
 127         $tableName = current($this->tableNames);
 128         return $this->dataSet->getTable($tableName);
 129     }
 130
 131     /**
 132      * Returns the name of the current table.
 133      *
 134      * @return string
 135      */
 136     public function key()
 137     {
 138         return $this->current()->getTableMetaData()->getTableName();
 139     }
 140
 141     /**
 142      * advances to the next element.
 143      *
 144      */
 145     public function next()
 146     {
 147         if ($this->reverse) {
 148             prev($this->tableNames);
 149         } else {
 150             next($this->tableNames);
 151         }
 152     }
 153
 154     /**
 155      * Rewinds to the first element
 156      */
 157     public function rewind()
 158     {
 159         if ($this->reverse) {
 160             end($this->tableNames);
 161         } else {
 162             reset($this->tableNames);
 163         }
 164     }
 165
 166     /**
 167      * Returns true if the current index is valid
 168      *
 169      * @return bool
 170      */
 171     public function valid()
 172     {
 173         return (current($this->tableNames) !== FALSE);
 174     }
 175 }
 176 ?>