API Documentation

Test/DbAdapter.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Test
subpackage
PHPUnit
version
$Id: DbAdapter.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Test_DbAdapter

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Test_DbAdapter

Extends from
Zend_Db_Adapter_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Test
subpackage
PHPUnit
Properties
$_statementStack
$_connected
$_listTables
$_lastInsertIdStack
$_describeTables
$_quoteIdentifierSymbol
Methods
__construct
appendStatementToStack
appendLastInsertIdToStack
setQuoteIdentifierSymbol
getQuoteIdentifierSymbol
setListTables
listTables
setDescribeTable
describeTable
_connect
isConnected
closeConnection
prepare
lastInsertId
_beginTransaction
_commit
_rollBack
setFetchMode
limit
supportsParameters
getServerVersion

Description

Testing Database Adapter which acts as a stack for SQL Results

Properties

$_connected

boolean $_connected = 'false'

Details

$_connected
boolean
visibility
protected
default
false
final
false
static
false

$_describeTables

array $_describeTables = 'array'

Details

$_describeTables
array
visibility
protected
default
array
final
false
static
false

$_lastInsertIdStack

array $_lastInsertIdStack = 'array'

Details

$_lastInsertIdStack
array
visibility
protected
default
array
final
false
static
false

$_listTables

array $_listTables = 'array'

Details

$_listTables
array
visibility
protected
default
array
final
false
static
false

$_quoteIdentifierSymbol

string $_quoteIdentifierSymbol = ''

Details

$_quoteIdentifierSymbol
string
visibility
protected
default
final
false
static
false

$_statementStack

array $_statementStack = 'array'

Details

$_statementStack
array
visibility
protected
default
array
final
false
static
false

Methods

__construct

__construct( ) :

Empty constructor to make it parameterless.

Details
visibility
public
final
false
static
false

_beginTransaction

_beginTransaction( ) :

Begin a transaction.

Details
visibility
protected
final
false
static
false

_commit

_commit( ) :

Commit a transaction.

Details
visibility
protected
final
false
static
false

_connect

_connect( ) : void

Creates a connection to the database.

Details
visibility
protected
final
false
static
false

_rollBack

_rollBack( ) :

Roll-back a transaction.

Details
visibility
protected
final
false
static
false

appendLastInsertIdToStack

appendLastInsertIdToStack( int|string $id ) : Zend_Test_DbAdapter

Append a new Insert Id to the {@see lastInsertId}.

Arguments
$id
intstring
Details
visibility
public
final
false
static
false

appendStatementToStack

appendStatementToStack( Zend_Test_DbStatement $stmt ) : Zend_Test_DbAdapter

Append a new Statement to the SQL Result Stack.

Arguments
$stmt
Zend_Test_DbStatement
Details
visibility
public
final
false
static
false

closeConnection

closeConnection( ) : void

Force the connection to close.

Details
visibility
public
final
false
static
false

describeTable

describeTable( string $tableName, string $schemaName = null ) : array

Returns the column descriptions for a table.

The return value is an associative array keyed by the column name, as returned by the RDBMS.

The value of each array element is an associative array with the following keys:

SCHEMA_NAME => string; name of database or schema TABLE_NAME => string; COLUMN_NAME => string; column name COLUMN_POSITION => number; ordinal position of column in table DATA_TYPE => string; SQL datatype name of column DEFAULT => string; default expression of column, null if none NULLABLE => boolean; true if column can have nulls LENGTH => number; length of CHAR/VARCHAR SCALE => number; scale of NUMERIC/DECIMAL PRECISION => number; precision of NUMERIC/DECIMAL UNSIGNED => boolean; unsigned property of an integer type PRIMARY => boolean; true if column is part of the primary key PRIMARY_POSITION => integer; position of column in primary key

Arguments
$tableName
string
$schemaName
string
OPTIONAL
Output
array
Details
visibility
public
final
false
static
false

getQuoteIdentifierSymbol

getQuoteIdentifierSymbol( ) : string

Returns the symbol the adapter uses for delimited identifiers.

Output
string
Details
visibility
public
final
false
static
false

getServerVersion

getServerVersion( ) : string

Retrieve server version in PHP style

Output
string
Details
visibility
public
final
false
static
false

isConnected

isConnected( ) : boolean

Test if a connection is active

Output
boolean
Details
visibility
public
final
false
static
false

lastInsertId

lastInsertId( string $tableName = null, string $primaryKey = null ) : string

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

As a convention, on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2), this method forms the name of a sequence from the arguments and returns the last id generated by that sequence. On RDBMS brands that support IDENTITY/AUTOINCREMENT columns, this method returns the last value generated for such a column, and the table name argument is disregarded.

Arguments
$tableName
string
OPTIONAL Name of table.
$primaryKey
string
OPTIONAL Name of primary key column.
Output
string
Details
visibility
public
final
false
static
false

limit

limit( mixed $sql, integer $count, integer $offset = 0 ) : string

Adds an adapter-specific LIMIT clause to the SELECT statement.

Arguments
$sql
mixed
$count
integer
$offset
integer
Output
string
Details
visibility
public
final
false
static
false

listTables

listTables( ) : array

Returns a list of the tables in the database.

Output
array
Details
visibility
public
final
false
static
false

prepare

prepare( string|Zend_Db_Select $sql ) : Zend_Db_Statment|PDOStatement

Prepare a statement and return a PDOStatement-like object.

Arguments
$sql
stringZend_Db_Select
SQL query
Output
Zend_Db_Statment|PDOStatement
Details
visibility
public
final
false
static
false

setDescribeTable

setDescribeTable( string $table, array $tableInfo ) : Zend_Test_DbAdapter

Arguments
$table
string
$tableInfo
array
Details
visibility
public
final
false
static
false

setFetchMode

setFetchMode( integer $mode ) : void

Set the fetch mode.

Arguments
$mode
integer
Details
visibility
public
final
false
static
false
throws

setListTables

setListTables( array $listTables ) :

Set the result from {@see listTables()}.

Arguments
$listTables
array
Details
visibility
public
final
false
static
false

setQuoteIdentifierSymbol

setQuoteIdentifierSymbol(  $symbol ) :

Arguments
$symbol
Details
visibility
public
final
false
static
false
setQuoteIdentifierSymbol
string

supportsParameters

supportsParameters( string $type ) : bool

Check if the adapter supports real SQL parameters.

Arguments
$type
string
'positional' or 'named'
Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.