Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Db_Adapter_Sqlsrv Class Reference

Inheritance diagram for Zend_Db_Adapter_Sqlsrv:
Zend_Db_Adapter_Abstract

Public Member Functions

 setTransactionIsolationLevel ($level=null)
 isConnected ()
 closeConnection ()
 prepare ($sql)
 lastInsertId ($tableName=null, $primaryKey=null)
 insert ($table, array $bind)
 listTables ()
 describeTable ($tableName, $schemaName=null)
 setFetchMode ($mode)
 limit ($sql, $count, $offset=0)
 supportsParameters ($type)
 getServerVersion ()

Protected Member Functions

 _connect ()
 _checkRequiredOptions (array $config)
 _quote ($value)
 _beginTransaction ()
 _commit ()
 _rollBack ()

Protected Attributes

 $_config
 $_lastInsertId
 $_lastInsertSQL = 'SELECT SCOPE_IDENTITY() as Current_Identity'
 $_numericDataTypes
 $_defaultStmtClass = 'Zend_Db_Statement_Sqlsrv'

Detailed Description

Definition at line 39 of file Sqlsrv.php.


Member Function Documentation

_beginTransaction (  ) [protected]

Leave autocommit mode and begin a transaction.

Returns:
void
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 518 of file Sqlsrv.php.

_checkRequiredOptions ( array $  config ) [protected]

Check for config options that are mandatory. Throw exceptions if any are missing.

Parameters:
array$config
Exceptions:
Zend_Db_Adapter_Exception

See also:
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 178 of file Sqlsrv.php.

_commit (  ) [protected]

Commit a transaction and return to autocommit mode.

Returns:
void
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 532 of file Sqlsrv.php.

_connect (  ) [protected]

Creates a connection resource.

Returns:
void
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

See also:
Zend_Db_Adapter_Sqlsrv_Exception
Zend_Db_Adapter_Sqlsrv_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 112 of file Sqlsrv.php.

_quote ( value ) [protected]

Quote a raw string.

Parameters:
string$valueRaw string
Returns:
string Quoted string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 308 of file Sqlsrv.php.

_rollBack (  ) [protected]

Roll back a transaction and return to autocommit mode.

Returns:
void
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 546 of file Sqlsrv.php.

closeConnection (  )

Force the connection to close.

Returns:
void

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 270 of file Sqlsrv.php.

describeTable ( tableName,
schemaName = null 
)

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

Todo:
Discover integer unsigned property.
Parameters:
string$tableName
string$schemaNameOPTIONAL
Returns:
array

Discover metadata information about this table.

Discover primary key column(s) for this table.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 431 of file Sqlsrv.php.

getServerVersion (  )

Retrieve server version in PHP style

Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 650 of file Sqlsrv.php.

insert ( table,
array $  bind 
)

Inserts a table row with specified data.

Parameters:
mixed$tableThe table to insert data into.
array$bindColumn-value pairs.
Returns:
int The number of affected rows.

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 356 of file Sqlsrv.php.

isConnected (  )

Test if a connection is active

Returns:
boolean

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 258 of file Sqlsrv.php.

lastInsertId ( tableName = null,
primaryKey = null 
)

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.

Parameters:
string$tableNameOPTIONAL Name of table.
string$primaryKeyOPTIONAL Name of primary key column.
Returns:
string

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 333 of file Sqlsrv.php.

limit ( sql,
count,
offset = 0 
)

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

Parameters:
string$sql
integer$count
integer$offsetOPTIONAL
Returns:
string
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

See also:
Zend_Db_Adapter_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 592 of file Sqlsrv.php.

listTables (  )

Returns a list of the tables in the database.

Returns:
array

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 394 of file Sqlsrv.php.

prepare ( sql )

Returns an SQL statement for preparation.

Parameters:
string$sqlThe SQL statement with placeholders.
Returns:
Zend_Db_Statement_Sqlsrv

See also:
Zend_Loader

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 284 of file Sqlsrv.php.

setFetchMode ( mode )

Set the fetch mode.

Todo:
Support FETCH_CLASS and FETCH_INTO.
Parameters:
integer$modeA fetch mode.
Returns:
void
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 563 of file Sqlsrv.php.

setTransactionIsolationLevel ( level = null )

Set the transaction isoltion level.

Parameters:
integer | null$levelA fetch mode from SQLSRV_TXN_*.
Returns:
true
Exceptions:
Zend_Db_Adapter_Sqlsrv_Exception

Definition at line 213 of file Sqlsrv.php.

supportsParameters ( type )

Check if the adapter supports real SQL parameters.

Parameters:
string$type'positional' or 'named'
Returns:
bool

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 635 of file Sqlsrv.php.


Field Documentation

$_config [protected]
Initial value:
 array(
        'dbname'       => null,
        'username'     => null,
        'password'     => null,
    )

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 52 of file Sqlsrv.php.

$_numericDataTypes [protected]
Initial value:
 array(
        Zend_Db::INT_TYPE    => Zend_Db::INT_TYPE,
        Zend_Db::BIGINT_TYPE => Zend_Db::BIGINT_TYPE,
        Zend_Db::FLOAT_TYPE  => Zend_Db::FLOAT_TYPE,
        'INT'                => Zend_Db::INT_TYPE,
        'SMALLINT'           => Zend_Db::INT_TYPE,
        'TINYINT'            => Zend_Db::INT_TYPE,
        'BIGINT'             => Zend_Db::BIGINT_TYPE,
        'DECIMAL'            => Zend_Db::FLOAT_TYPE,
        'FLOAT'              => Zend_Db::FLOAT_TYPE,
        'MONEY'              => Zend_Db::FLOAT_TYPE,
        'NUMERIC'            => Zend_Db::FLOAT_TYPE,
        'REAL'               => Zend_Db::FLOAT_TYPE,
        'SMALLMONEY'         => Zend_Db::FLOAT_TYPE,
    )

Reimplemented from Zend_Db_Adapter_Abstract.

Definition at line 83 of file Sqlsrv.php.


The documentation for this class was generated from the following file: