API Documentation

Db/Adapter/Firebird.php

Includes Classes 
category
ZendX
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
ZendX_Db
subpackage
Adapter
version
$Id: $
Classes
ZendX_Db_Adapter_Firebird

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.

\ZendX_Db_Adapter_Firebird

Extends from
\Zend_Db_Adapter_Abstract
category
ZendX
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
ZendX_Db
subpackage
Adapter
Properties
$_autoQuoteIdentifiers
$_numericDataTypes
$_transResource
Methods
_beginTransaction
_commit
_connect
_formatDbConnString
_quote
_rollBack
closeConnection
describeTable
getServerVersion
getTransaction
isConnected
lastInsertId
lastSequenceId
limit
listTables
nextSequenceId
prepare
quoteTableAs
setFetchMode
supportsParameters

Description

Properties

$_autoQuoteIdentifiers

bool $_autoQuoteIdentifiers = 'true'

Specifies whether the adapter automatically quotes identifiers.

If true, most SQL generated by Zend_Db classes applies identifier quoting automatically. If false, developer must quote identifiers themselves by calling quoteIdentifier().

Details

bool
visibility
protected
default
true
final
false
static
false

$_numericDataTypes

array $_numericDataTypes = 'array'

Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.

Values are: 0 = 32-bit integer 1 = 64-bit integer 2 = float or decimal

Details

array
Associative array of datatypes to values 0, 1, or 2.
visibility
protected
default
array
final
false
static
false

$_transResource

\transaction $_transResource = 'null'

The transaction resource.

Details

\transaction
visibility
protected
default
null
final
false
static
false

Methods

_beginTransaction

_beginTransaction( ) : void

Begin a transaction.

Details
visibility
protected
final
false
static
false

_commit

_commit( ) : void

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
throws

_formatDbConnString

_formatDbConnString(  $host,  $port,  $dbname ) : void

Format a connection string to connect to database

Arguments
$host
$port
$dbname
Details
visibility
protected
final
false
static
false

_quote

_quote( string $value ) : string

Quote a raw string.

Arguments
$value
string
Raw string
Output
string
Quoted string
Details
visibility
protected
final
false
static
false

_rollBack

_rollBack( ) : void

Roll-back a transaction.

Details
visibility
protected
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 IDENTITY => integer; true if column is auto-generated with unique values

Arguments
$tableName
string
$schemaName
string
OPTIONAL
Output
array
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

getTransaction

getTransaction( ) : bool

Return the status of current transaction.

Output
bool
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. Firebird, 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.

Firebird does not support IDENTITY columns, so if the sequence is not specified, this method returns null.

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

lastSequenceId

lastSequenceId( string $sequenceName ) : string

Return the most recent value from the specified sequence in the database.

This is supported only on RDBMS brands that support sequences (e.g. Firebird, Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Arguments
$sequenceName
string
Output
string
Details
visibility
public
final
false
static
false

limit

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

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

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

listTables

listTables( ) : array

Returns a list of the tables in the database.

Output
array
Details
visibility
public
final
false
static
false

nextSequenceId

nextSequenceId( string $sequenceName ) : integer

Generate a new value from the specified sequence in the database, and return it.

This is supported only on RDBMS brands that support sequences (e.g. Firebird, Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

Arguments
$sequenceName
string
Output
integer
Details
visibility
public
final
false
static
false

prepare

prepare( string $sql ) : \ZendX_Db_Statement_Firebird

Prepare a statement and return a Statement resource.

Arguments
$sql
string
SQL query
Details
visibility
public
final
false
static
false

quoteTableAs

quoteTableAs( string|array|\Zend_Db_Expr $ident, string $alias = null, boolean $auto = false ) : string

Quote a table identifier and alias.

Arguments
$ident
stringarray\Zend_Db_Expr
The identifier or expression.
$alias
string
An alias for the table.
$auto
boolean
If true, heed the AUTO_QUOTE_IDENTIFIERS config option.
Output
string
The quoted identifier and alias.
Details
visibility
public
final
false
static
false

setFetchMode

setFetchMode( int $mode ) : void

Set the fetch mode.

Arguments
$mode
int
Details
visibility
public
final
false
static
false

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 0.12.2.