tests/PHPUnit/Extensions/Database/DataSet/DataSetFilter.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/AbstractDataSet.php';
  51 require_once 'PHPUnit/Extensions/Database/DataSet/TableFilter.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * A dataset decorator that allows filtering out tables and table columns from
  57  * results.
  58  *
  59  * @category   Testing
  60  * @package    PHPUnit
  61  * @author     Mike Lively <m@digitalsandwich.com>
  62  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  63  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  64  * @version    Release: 3.3.17
  65  * @link       http://www.phpunit.de/
  66  * @since      Class available since Release 3.2.0
  67  */
  68 class PHPUnit_Extensions_Database_DataSet_DataSetFilter extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
  69 {
  70
  71     /**
  72      * The dataset being decorated.
  73      * @var PHPUnit_Extensions_Database_DataSet_IDataSet
  74      */
  75     protected $originalDataSet;
  76
  77     /**
  78      * The tables to exclude from the data set.
  79      * @var Array
  80      */
  81     protected $excludeTables;
  82
  83     /**
  84      * The columns to exclude from the data set.
  85      * @var Array
  86      */
  87     protected $excludeColumns;
  88
  89     /**
  90      * Creates a new filtered data set.
  91      *
  92      * The $exclude tables should be an associative array using table names as
  93      * the key and an array of column names to exclude for the value. If you
  94      * would like to exclude a full table set the value of the table's entry
  95      * to the special string '*'.
  96      *
  97      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $originalDataSet
  98      * @param Array $excludeTables
  99      */
 100     public function __construct(PHPUnit_Extensions_Database_DataSet_IDataSet $originalDataSet, Array $excludeTables)
 101     {
 102         $this->originalDataSet = $originalDataSet;
 103         $this->excludeTables = $excludeTables;
 104
 105         foreach ($this->excludeTables as $tableName => $values) {
 106             if (is_array($values)) {
 107                 $this->excludeColumns[$tableName] = $values;
 108             } elseif ($values == '*') {
 109                 $this->excludeTables[] = $tableName;
 110             } else {
 111                 $this->excludeColumns[$tableName] = (array)$values;
 112             }
 113         }
 114     }
 115
 116     /**
 117      * Creates an iterator over the tables in the data set. If $reverse is
 118      * true a reverse iterator will be returned.
 119      *
 120      * @param bool $reverse
 121      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 122      */
 123     protected function createIterator($reverse = FALSE)
 124     {
 125         $original_tables = $this->originalDataSet->getIterator($reverse);
 126         $new_tables = array();
 127
 128         foreach ($original_tables as $table) {
 129             /* @var $table PHPUnit_Extensions_Database_DataSet_ITable */
 130             $tableName = $table->getTableMetaData()->getTableName();
 131
 132             if (in_array($tableName, $this->excludeTables)) {
 133                 continue;
 134             } elseif (array_key_exists($tableName, $this->excludeColumns)) {
 135                 $new_tables[] = new PHPUnit_Extensions_Database_DataSet_TableFilter($table, $this->excludeColumns[$tableName]);
 136             } else {
 137                 $new_tables[] = $table;
 138             }
 139         }
 140
 141         return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($new_tables);
 142     }
 143 }
 144 ?>