tests/PHPUnit/Extensions/Database/DataSet/ReplacementTableIterator.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 require_once 'PHPUnit/Extensions/Database/DataSet/ReplacementTable.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * The default table iterator
  57  *
  58  * @category   Testing
  59  * @package    PHPUnit
  60  * @author     Mike Lively <m@digitalsandwich.com>
  61  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  62  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  63  * @version    Release: 3.3.17
  64  * @link       http://www.phpunit.de/
  65  * @since      Class available since Release 3.2.0
  66  */
  67 class PHPUnit_Extensions_Database_DataSet_ReplacementTableIterator implements OuterIterator, PHPUnit_Extensions_Database_DataSet_ITableIterator
  68 {
  69
  70     /**
  71      * @var PHPUnit_Extensions_Database_DataSet_ITableIterator
  72      */
  73     protected $innerIterator;
  74
  75     /**
  76      * @var array
  77      */
  78     protected $fullReplacements;
  79
  80     /**
  81      * @var array
  82      */
  83     protected $subStrReplacements;
  84
  85     /**
  86      * Creates a new replacement table iterator object.
  87      *
  88      * @param PHPUnit_Extensions_Database_DataSet_ITableIterator $innerIterator
  89      * @param array $fullReplacements
  90      * @param array $subStrReplacements
  91      */
  92     public function __construct(PHPUnit_Extensions_Database_DataSet_ITableIterator $innerIterator, Array $fullReplacements = array(), Array $subStrReplacements = array())
  93     {
  94         $this->innerIterator = $innerIterator;
  95         $this->fullReplacements = $fullReplacements;
  96         $this->subStrReplacements = $subStrReplacements;
  97     }
  98
  99     /**
 100      * Adds a new full replacement
 101      *
 102      * Full replacements will only replace values if the FULL value is a match
 103      *
 104      * @param string $value
 105      * @param string $replacement
 106      */
 107     public function addFullReplacement($value, $replacement)
 108     {
 109         $this->fullReplacements[$value] = $replacement;
 110     }
 111
 112     /**
 113      * Adds a new substr replacement
 114      *
 115      * Substr replacements will replace all occurances of the substr in every column
 116      *
 117      * @param string $value
 118      * @param string $replacement
 119      */
 120     public function addSubStrReplacement($value, $replacement)
 121     {
 122         $this->subStrReplacements[$value] = $replacement;
 123     }
 124
 125     /**
 126      * Returns the current table.
 127      *
 128      * @return PHPUnit_Extensions_Database_DataSet_ITable
 129      */
 130     public function getTable()
 131     {
 132         return $this->current();
 133     }
 134
 135     /**
 136      * Returns the current table's meta data.
 137      *
 138      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
 139      */
 140     public function getTableMetaData()
 141     {
 142         $this->current()->getTableMetaData();
 143     }
 144
 145     /**
 146      * Returns the current table.
 147      *
 148      * @return PHPUnit_Extensions_Database_DataSet_ITable
 149      */
 150     public function current()
 151     {
 152         return new PHPUnit_Extensions_Database_DataSet_ReplacementTable($this->innerIterator->current(), $this->fullReplacements, $this->subStrReplacements);
 153     }
 154
 155     /**
 156      * Returns the name of the current table.
 157      *
 158      * @return string
 159      */
 160     public function key()
 161     {
 162         return $this->current()->getTableMetaData()->getTableName();
 163     }
 164
 165     /**
 166      * advances to the next element.
 167      *
 168      */
 169     public function next()
 170     {
 171         $this->innerIterator->next();
 172     }
 173
 174     /**
 175      * Rewinds to the first element
 176      */
 177     public function rewind()
 178     {
 179         $this->innerIterator->rewind();
 180     }
 181
 182     /**
 183      * Returns true if the current index is valid
 184      *
 185      * @return bool
 186      */
 187     public function valid()
 188     {
 189         return $this->innerIterator->valid();
 190     }
 191
 192     public function getInnerIterator()
 193     {
 194         return $this->innerIterator;
 195     }
 196 }
 197 ?>