API Documentation

Db/Adapter/Pdo/Ibm.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_Db
subpackage
Adapter
version
$Id: Ibm.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Db_Adapter_Pdo_Ibm

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_Db_Adapter_Pdo_Ibm

Extends from
Zend_Db_Adapter_Pdo_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_Db
subpackage
Adapter
Properties
$_pdoType
$_serverType
$_numericDataTypes
Methods
_connect
_dsn
_checkRequiredOptions
prepare
listTables
describeTable
insert
limit
lastInsertId
lastSequenceId
nextSequenceId
getServerVersion

Description

Properties

$_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

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

$_pdoType

string $_pdoType = 'ibm'

PDO type.

Details

$_pdoType
string
visibility
protected
default
ibm
final
false
static
false

$_serverType

string $_serverType = 'null'

The IBM data server connected to

Details

$_serverType
string
visibility
protected
default
null
final
false
static
false

Methods

_checkRequiredOptions

_checkRequiredOptions( array $config ) : void

Checks required options

Arguments
$config
array
Details
visibility
protected
final
false
static
false
throws

_connect

_connect( ) : void

Creates a PDO object and connects to the database.

The IBM data server is set. Current options are DB2 or IDS

Details
visibility
public
final
false
static
false
throws
todo
also differentiate between z/OS and i/5

_dsn

_dsn( ) : string

Creates a PDO DSN for the adapter from $this->_config settings.

Output
string
Details
visibility
protected
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
todo
Discover integer unsigned property.

getServerVersion

getServerVersion( ) : string

Retrieve server version in PHP style Pdo_Idm doesn't support getAttribute(PDO::ATTR_SERVER_VERSION)

Output
string
Details
visibility
public
final
false
static
false

insert

insert( mixed $table, array $bind ) : int

Inserts a table row with specified data.

Special handling for PDO_IBM remove empty slots

Arguments
$table
mixed
The table to insert data into.
$bind
array
Column-value pairs.
Output
int
The number of affected rows.
Details
visibility
public
final
false
static
false

lastInsertId

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

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

Arguments
$tableName
string
OPTIONAL
$primaryKey
string
OPTIONAL
Output
integer
Details
visibility
public
final
false
static
false

lastSequenceId

lastSequenceId( string $sequenceName ) : integer

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

Arguments
$sequenceName
string
Output
integer
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
OPTIONAL
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

nextSequenceId

nextSequenceId( string $sequenceName ) : integer

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

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

prepare

prepare( string $sql ) : PDOStatement

Prepares an SQL statement.

Arguments
$sql
string
The SQL statement with placeholders.
Output
PDOStatement
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.