Db/Adapter/Sqlsrv.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Adapter  
Version
$Id$  

\Zend_Db_Adapter_Sqlsrv

Package: Zend_Db\Adapter
Class for connecting to SQL databases and performing common operations.
Parent(s)
\Zend_Db_Adapter_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_config = array('dbname' => null, 'username' => null, 'password' => null)
User-provided configuration.
Basic keys are: username => (string) Connect to the database as this username. password => (string) Password associated with the username. dbname => The name of the local SQL Server instance
Default valuearray('dbname' => null, 'username' => null, 'password' => null)Details
Type
array
>VPropertyprotectedstring $_defaultStmtClass = 'Zend_Db_Statement_Sqlsrv'
Default class name for a DB statement.
Default value'Zend_Db_Statement_Sqlsrv'Details
Type
string
>VPropertyprotectedint $_lastInsertId
Last insert id from INSERT query
Details
Type
int
>VPropertyprotectedstring $_lastInsertSQL = 'SELECT SCOPE_IDENTITY() as Current_Identity'
Query used to fetch last insert id
Default value'SELECT SCOPE_IDENTITY() as Current_Identity'Details
Type
string
>VPropertyprotectedarray $_numericDataTypes = 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)
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
Default valuearray(\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)Details
Type
array

Methods

methodprotected_beginTransaction() : void

Leave autocommit mode and begin a transaction.

Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodprotected_checkRequiredOptions(array $config) : void

Check for config options that are mandatory.

Throw exceptions if any are missing.
Parameters
NameTypeDescription
$configarray
Throws
ExceptionDescription
\Zend_Db_Adapter_Exception
methodprotected_commit() : void

Commit a transaction and return to autocommit mode.

Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodprotected_connect() : void

Creates a connection resource.

Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodprotected_quote(string $value) : string

Quote a raw string.

Parameters
NameTypeDescription
$valuestring

Raw string

Returns
TypeDescription
stringQuoted string
methodprotected_rollBack() : void

Roll back a transaction and return to autocommit mode.

Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodpubliccloseConnection() : void

Force the connection to close.

methodpublicdescribeTable(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 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
Parameters
NameTypeDescription
$tableNamestring
$schemaNamestring

OPTIONAL

Returns
TypeDescription
array
Details
Todo
Discover integer unsigned property.  
methodpublicgetServerVersion() : string

Retrieve server version in PHP style

Returns
TypeDescription
string
methodpublicinsert(mixed $table, array $bind) : int

Inserts a table row with specified data.

Parameters
NameTypeDescription
$tablemixed

The table to insert data into.

$bindarray

Column-value pairs.

Returns
TypeDescription
intThe number of affected rows.
methodpublicisConnected() : boolean

Test if a connection is active

Returns
TypeDescription
boolean
methodpubliclastInsertId(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.
Parameters
NameTypeDescription
$tableNamestring

OPTIONAL Name of table.

$primaryKeystring

OPTIONAL Name of primary key column.

Returns
TypeDescription
string
methodpubliclimit(string $sql, integer $count, integer $offset = 0) : string

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

Parameters
NameTypeDescription
$sqlstring
$countinteger
$offsetinteger

OPTIONAL

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodpubliclistTables() : array

Returns a list of the tables in the database.

Returns
TypeDescription
array
methodpublicprepare(string $sql) : \Zend_Db_Statement_Sqlsrv

Returns an SQL statement for preparation.

Parameters
NameTypeDescription
$sqlstring

The SQL statement with placeholders.

Returns
TypeDescription
\Zend_Db_Statement_Sqlsrv
methodpublicsetFetchMode(integer $mode) : void

Set the fetch mode.

Parameters
NameTypeDescription
$modeinteger

A fetch mode.

Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
Details
Todo
Support FETCH_CLASS and FETCH_INTO.  
methodpublicsetTransactionIsolationLevel(integer | null $level = null) : true

Set the transaction isoltion level.

Parameters
NameTypeDescription
$levelinteger | null

A fetch mode from SQLSRV_TXN_*.

Returns
TypeDescription
true
Throws
ExceptionDescription
\Zend_Db_Adapter_Sqlsrv_Exception
methodpublicsupportsParameters(string $type) : bool

Check if the adapter supports real SQL parameters.

Parameters
NameTypeDescription
$typestring

'positional' or 'named'

Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.2.0 .