API Documentation

ZendX/Db/Adapter/Firebird.php

Includes |Classes |

Properties

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.


Includes

Zend/Db/Adapter/Abstract.php (Require Once)
Zend/Db/Profiler.php (Require Once)
Zend/Db/Select.php (Require Once)
ZendX/Db/Statement/Firebird.php (Require Once)

Classes

ZendX_Db_Adapter_Firebird

Properties

 
 
ZendX  
Adapter  
No 
No 

Description



Methods

_beginTransaction, _commit, _connect, _formatDbConnString, _quote, _rollBack, closeConnection, describeTable, getServerVersion, getTransaction, isConnected, lastInsertId, lastSequenceId, limit, listTables, nextSequenceId, prepare, quoteTableAs, setFetchMode, supportsParameters,

_beginTransaction( ) : void

Description

Begin a transaction.

Return value

Type Description
void

_commit( ) : void

Description

Commit a transaction.

Return value

Type Description
void

_connect( ) : void

Description

Creates a connection to the database.

Return value

Type Description
void

Tags

Name Description
throws ZendX_Db_Adapter_Firebird_Exception

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

Description

Format a connection string to connect to database

Arguments

Name Type Description Default
$host n/a
$port n/a
$dbname n/a

Return value

Type Description
void

_quote( string   $value, ) : string

Description

Quote a raw string.

Arguments

Name Type Description Default
$value string | Raw string

Return value

Type Description
string Quoted string

_rollBack( ) : void

Description

Roll-back a transaction.

Return value

Type Description
void

closeConnection( ) : void

Description

Force the connection to close.

Return value

Type Description
void

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

Description

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

Name Type Description Default
$tableName string |
$schemaName string | OPTIONAL null

Return value

Type Description
array

getServerVersion( ) : string

Description

Retrieve server version in PHP style

Return value

Type Description
string

getTransaction( ) : bool

Description

Return the status of current transaction.

Return value

Type Description
bool

isConnected( ) : boolean

Description

Test if a connection is active

Return value

Type Description
boolean

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

Description

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

Name Type Description Default
$tableName string | OPTIONAL Name of table. null
$primaryKey string | OPTIONAL Name of primary key column. null

Return value

Type Description
string

Tags

Name Description
throws ZendX_Db_Adapter_Firebird_Exception

lastSequenceId( string   $sequenceName, ) : string

Description

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

Name Type Description Default
$sequenceName string |

Return value

Type Description
string

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

Description

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

Arguments

Name Type Description Default
$sql string |
$count integer |
$offset integer | 0

Return value

Type Description
string

Tags

Name Description
throws

listTables( ) : array

Description

Returns a list of the tables in the database.

Return value

Type Description
array

nextSequenceId( string   $sequenceName, ) : integer

Description

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

Name Type Description Default
$sequenceName string |

Return value

Type Description
integer

prepare( string   $sql, ) : ZendX_Db_Statement_Firebird

Description

Prepare a statement and return a Statement resource.

Arguments

Name Type Description Default
$sql string | SQL query

Return value

Type Description
ZendX_Db_Statement_Firebird

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

Description

Quote a table identifier and alias.

Arguments

Name Type Description Default
$ident string | array | Zend_Db_Expr | The identifier or expression.
$alias string | An alias for the table. null
$auto boolean | If true, heed the AUTO_QUOTE_IDENTIFIERS config option. false

Return value

Type Description
string The quoted identifier and alias.

setFetchMode( int   $mode, ) : void

Description

Set the fetch mode.

Arguments

Name Type Description Default
$mode int |

Return value

Type Description
void

supportsParameters( string   $type, ) : bool

Description

Check if the adapter supports real SQL parameters.

Arguments

Name Type Description Default
$type string | 'positional' or 'named'

Return value

Type Description
bool

Properties

$_autoQuoteIdentifiers, $_numericDataTypes, $_transResource,

  protected  $_autoQuoteIdentifiers = true

Specifies whether the adapter automatically quotes identifiers.bool
<p>If true, most SQL generated by Zend_Db classes applies identifier quoting automatically. If false, developer must quote identifiers themselves by calling quoteIdentifier().</p>

array  protected  $_numericDataTypes = array

Keys are UPPERCASE SQL datatypes or the constants Zend_Db::INT_TYPE, Zend_Db::BIGINT_TYPE, or Zend_Db::FLOAT_TYPE.Associative array of datatypes to values 0, 1, or 2.
<p>Values are: 0 = 32-bit integer 1 = 64-bit integer 2 = float or decimal</p>

  protected  $_transResource = null

The transaction resource.transaction


Documentation was generated by DocBlox.