PHP Class PHPUnit_Extensions_Database_DB_DefaultDatabaseConnection, qcodo

Author: Mike Lively ([email protected])

Inheritance: implements PHPUnit_Extensions_Database_DB_IDatabaseConnection

Show file Open project: qcodo/qcodo Class Usage Examples

Protected Properties

Property	Type	Description
$connection	PDO
$metaData	PHPUnit_Extensions_Database_DB_IMetaData	The metadata object used to retrieve table meta data from the database.

Public Methods

Method	Description
__construct ( PDO $connection, string $schema = '' )	Creates a new database connection
allowsCascading ( ) : boolean	Returns true if the connection allows cascading
close ( )	Close this connection.
createDataSet ( array $tableNames = NULL ) : PHPUnit_Extensions_Database_DataSet_IDataSet	Creates a dataset containing the specified table names. If no table names are specified then it will created a dataset over the entire database.
createQueryTable ( string $resultName, string $sql ) : PHPUnit_Extensions_Database_DB_Table	Creates a table with the result of the specified SQL statement.
getConfig ( ) : PHPUnit_Extensions_Database_Database_DatabaseConfig	Returns this connection database configuration
getConnection ( ) : PDO	Returns a PDO Connection
getMetaData ( ) : PHPUnit_Extensions_Database_DB_IMetaData	Returns a database metadata object that can be used to retrieve table meta data from the database.
getRowCount ( string $tableName, string $whereClause = NULL )	Returns the number of rows in the given table. You can specify an optional where clause to return a subset of the table.
getSchema ( ) : string	Returns the schema for the connection.
getTruncateCommand ( ) : string	Returns the command used to truncate a table.
quoteSchemaObject ( string $object ) : string	Returns a quoted schema object. (table name, column name, etc)

Method Details

__construct() public method

Creates a new database connection

public __construct ( PDO $connection, string $schema = '' )
$connection	PDO
$schema	string	- The name of the database schema you will be testing against.

allowsCascading() public method

Returns true if the connection allows cascading

public allowsCascading ( ) : boolean
return	boolean

close() public method

Close this connection.

public close ( )

createDataSet() public method

Creates a dataset containing the specified table names. If no table names are specified then it will created a dataset over the entire database.

public createDataSet ( array $tableNames = NULL ) : PHPUnit_Extensions_Database_DataSet_IDataSet
$tableNames	array
return	PHPUnit_Extensions_Database_DataSet_IDataSet

createQueryTable() public method

Creates a table with the result of the specified SQL statement.

public createQueryTable ( string $resultName, string $sql ) : PHPUnit_Extensions_Database_DB_Table
$resultName	string
$sql	string
return	PHPUnit_Extensions_Database_DB_Table

getConfig() public method

Returns this connection database configuration

public getConfig ( ) : PHPUnit_Extensions_Database_Database_DatabaseConfig
return	PHPUnit_Extensions_Database_Database_DatabaseConfig

getConnection() public method

Returns a PDO Connection

public getConnection ( ) : PDO
return	PDO

getMetaData() public method

Returns a database metadata object that can be used to retrieve table meta data from the database.

public getMetaData ( ) : PHPUnit_Extensions_Database_DB_IMetaData
return	PHPUnit_Extensions_Database_DB_IMetaData

getRowCount() public method

Returns the number of rows in the given table. You can specify an optional where clause to return a subset of the table.

public getRowCount ( string $tableName, string $whereClause = NULL )
$tableName	string
$whereClause	string

getSchema() public method

Returns the schema for the connection.

public getSchema ( ) : string
return	string

getTruncateCommand() public method

Returns the command used to truncate a table.

public getTruncateCommand ( ) : string
return	string

quoteSchemaObject() public method

Returns a quoted schema object. (table name, column name, etc)

public quoteSchemaObject ( string $object ) : string
$object	string
return	string

Property Details

$connection protected property

protected PDO $connection
return	PDO

$metaData protected property

The metadata object used to retrieve table meta data from the database.

protected PHPUnit_Extensions_Database_DB_IMetaData $metaData
return	PHPUnit_Extensions_Database_DB_IMetaData