<?php
/**
 * PHPUnit
 *
 * Copyright (c) 2002-2008, Sebastian Bergmann <sb@sebastian-bergmann.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Testing
 * @package    PHPUnit
 * @author     Mike Lively <m@digitalsandwich.com>
 * @copyright  2002-2008 Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version    SVN: $Id: DefaultTableIterator.php 1985 2007-12-26 18:11:55Z sb $
 * @link       http://www.phpunit.de/
 * @since      File available since Release 3.2.0
 */

require_once 'PHPUnit/Framework.php';
require_once 'PHPUnit/Util/Filter.php';

require_once 'PHPUnit/Extensions/Database/DataSet/ITableIterator.php';

PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');

/**
 * The default table iterator
 *
 * @category   Testing
 * @package    PHPUnit
 * @author     Mike Lively <m@digitalsandwich.com>
 * @copyright  2008 Mike Lively <m@digitalsandwich.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version    Release: 3.2.9
 * @link       http://www.phpunit.de/
 * @since      Class available since Release 3.2.0
 */
class PHPUnit_Extensions_Database_DataSet_DefaultTableIterator implements PHPUnit_Extensions_Database_DataSet_ITableIterator {
  
  /**
   * An array of tables in the iterator.
   *
   * @var Array
   */
  protected $tables;
  
  /**
   * If this property is true then the tables will be iterated in reverse 
   * order.
   * 
   * @var bool
   */
  protected $reverse;

  /**
   * Creates a new default table iterator object.
   *
   * @param array $tables
   * @param bool $reverse
   */
  public function __construct(Array $tables, $reverse = false) {
    $this->tables = $tables;
    $this->reverse = $reverse;
    
    $this->rewind();
  }

  /**
   * Returns the current table.
   *
   * @return PHPUnit_Extensions_Database_DataSet_ITable
   */
  public function getTable() {
    $this->current();
  }

  /**
   * Returns the current table's meta data.
   *
   * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
   */
  public function getTableMetaData() {
    $this->current()->getTableMetaData();
  }

  /**
   * Returns the current table.
   *
   * @return PHPUnit_Extensions_Database_DataSet_ITable
   */
  public function current() {
    return current($this->tables);
  }

  /**
   * Returns the name of the current table.
   *
   * @return string
   */
  public function key() {
    return $this->current()->getTableMetaData()->getTableName();
  }

  /**
   * advances to the next element.
   *
   */
  public function next() {
    if ($this->reverse) {
      prev($this->tables);
    } else {
      next($this->tables);
    }
  }

  /**
   * Rewinds to the first element
   */
  public function rewind() {
    if ($this->reverse) {
      end($this->tables);
    } else {
      reset($this->tables);
    }
  }

  /**
   * Returns true if the current index is valid
   * 
   * @return bool
   */
  public function valid() {
    return ($this->current() !== false);
  }
}
?>