• Home
  • PHPUnit_Extensions_Database_DataSet_TableMetaDataFilter

PHP Class PHPUnit_Extensions_Database_DataSet_TableMetaDataFilter, qcodo

The if a whitelist (include) filter is specified, then only those columns will be included.
See link: http://www.phpunit.de/
Author: Mike Lively ([email protected])
Inheritance: extends PHPUnit_Extensions_Database_DataSet_AbstractTableMetaData
Show file Open project: qcodo/qcodo

Protected Properties

Property Type Description
$excludeColumns Array The columns to exclude from the meta data.
$includeColumns Array The columns to include from the meta data.
$originalMetaData PHPUnit_Extensions_Database_DataSet_ITableMetaData The table meta data being decorated.

Public Methods

Method Description
__construct ( PHPUnit_Extensions_Database_DataSet_ITableMetaData $originalMetaData, array $excludeColumns = [] ) Creates a new filtered table meta data object filtering out $excludeColumns.
addExcludeColumns ( array $excludeColumns ) Sets the columns to exclude from the table.
addIncludeColumns ( array $includeColumns ) Sets the columns to include in the table.
clearExcludeColumns ( ) Clears the excluded columns.
clearIncludeColumns ( ) Clears the included columns.
getColumns ( ) : array Returns the names of the columns in the table.
getPrimaryKeys ( ) : array Returns the names of the primary key columns in the table.
getTableName ( ) : string Returns the name of the table.

Method Details

__construct() public method

Creates a new filtered table meta data object filtering out $excludeColumns.
public __construct ( PHPUnit_Extensions_Database_DataSet_ITableMetaData $originalMetaData, array $excludeColumns = [] )
$originalMetaData PHPUnit_Extensions_Database_DataSet_ITableMetaData
$excludeColumns array - Deprecated. Use the set* methods instead.

addExcludeColumns() public method

Sets the columns to exclude from the table.
public addExcludeColumns ( array $excludeColumns )
$excludeColumns array

addIncludeColumns() public method

Sets the columns to include in the table.
public addIncludeColumns ( array $includeColumns )
$includeColumns array

clearExcludeColumns() public method

Clears the excluded columns.
public clearExcludeColumns ( )

clearIncludeColumns() public method

Clears the included columns.
public clearIncludeColumns ( )

getColumns() public method

Returns the names of the columns in the table.
public getColumns ( ) : array
return array

getPrimaryKeys() public method

Returns the names of the primary key columns in the table.
public getPrimaryKeys ( ) : array
return array

getTableName() public method

Returns the name of the table.
public getTableName ( ) : string
return string

Property Details

$excludeColumns protected property

The columns to exclude from the meta data.
protected Array $excludeColumns
return Array

$includeColumns protected property

The columns to include from the meta data.
protected Array $includeColumns
return Array

$originalMetaData protected property

The table meta data being decorated.
protected PHPUnit_Extensions_Database_DataSet_ITableMetaData $originalMetaData
return PHPUnit_Extensions_Database_DataSet_ITableMetaData