tests/PHPUnit/Extensions/Database/DataSet/TableFilter.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/AbstractTable.php';
  51 require_once 'PHPUnit/Extensions/Database/DataSet/TableMetaDataFilter.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * A table decorator that allows filtering out table columns from results.
  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_TableFilter extends PHPUnit_Extensions_Database_DataSet_AbstractTable
  68 {
  69
  70     /**
  71      * The table meta data being decorated.
  72      * @var PHPUnit_Extensions_Database_DataSet_ITable
  73      */
  74     protected $originalTable;
  75
  76     public function __construct(PHPUnit_Extensions_Database_DataSet_ITable $originalTable, Array $excludeColumns)
  77     {
  78         $this->originalTable = $originalTable;
  79         $this->setTableMetaData(new PHPUnit_Extensions_Database_DataSet_TableMetaDataFilter($originalTable->getTableMetaData(), $excludeColumns));
  80     }
  81
  82     /**
  83      * Returns the number of rows in this table.
  84      *
  85      * @return int
  86      */
  87     public function getRowCount()
  88     {
  89         return $this->originalTable->getRowCount();
  90     }
  91
  92     /**
  93      * Returns the value for the given column on the given row.
  94      *
  95      * @param int $row
  96      * @param int $column
  97      */
  98     public function getValue($row, $column)
  99     {
 100         if (in_array($column, $this->getTableMetaData()->getColumns())) {
 101             return $this->originalTable->getValue($row, $column);
 102         } else {
 103             throw new InvalidArgumentException("The given row ({$row}) and column ({$column}) do not exist in table {$this->getTableMetaData()->getTableName()}");
 104         }
 105     }
 106 }
 107 ?>