tests/PHPUnit/Extensions/Database/DataSet/TableMetaDataFilter.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/AbstractTableMetaData.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * A TableMetaData decorator that allows filtering out columns from another
  56  * metaData object.
  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_TableMetaDataFilter extends PHPUnit_Extensions_Database_DataSet_AbstractTableMetaData
  68 {
  69
  70     /**
  71      * The table meta data being decorated.
  72      * @var PHPUnit_Extensions_Database_DataSet_ITableMetaData
  73      */
  74     protected $originalMetaData;
  75
  76     /**
  77      * The columns to exclude from the meta data.
  78      * @var Array
  79      */
  80     protected $excludeColumns;
  81
  82     /**
  83      * Creates a new filtered table meta data object filtering out
  84      * $excludeColumns.
  85      *
  86      * @param PHPUnit_Extensions_Database_DataSet_ITableMetaData $originalMetaData
  87      * @param array $excludeColumns
  88      */
  89     public function __construct(PHPUnit_Extensions_Database_DataSet_ITableMetaData $originalMetaData, Array $excludeColumns)
  90     {
  91         $this->originalMetaData = $originalMetaData;
  92         $this->excludeColumns = $excludeColumns;
  93     }
  94
  95     /**
  96      * Returns the names of the columns in the table.
  97      *
  98      * @return array
  99      */
 100     public function getColumns()
 101     {
 102         return array_values(array_diff($this->originalMetaData->getColumns(), $this->excludeColumns));
 103     }
 104
 105     /**
 106      * Returns the names of the primary key columns in the table.
 107      *
 108      * @return array
 109      */
 110     public function getPrimaryKeys()
 111     {
 112         return $this->originalMetaData->getPrimaryKeys();
 113     }
 114
 115     /**
 116      * Returns the name of the table.
 117      *
 118      * @return string
 119      */
 120     public function getTableName()
 121     {
 122         return $this->originalMetaData->getTableName();
 123     }
 124 }
 125 ?>