Docs For Class OdbcConnector

Description

Implements interfaces:

IConnector

IConnector implementation for the PHP ODBC database extension.

BaseConnector
   |
   --OdbcConnector

Class Constant Summary

CONN_CURSOR = "connCursor"

DRIVER = "driver"

DRIVER_MSSQL_NATIVE = "SQL Native Client"

DRIVER_MSSQL_SERVER = "SQL Server"

DRIVER_MYSQL = "MySQL ODBC 5.1 Driver"

Method Summary

OdbcConnector OdbcConnector (array $connection, [array $options = array()])

string build (string $query, [array $options = array()])

bool commit ([array $options = array()])

int delete (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string driver (string $name)

array fetch (resource $stmt, [array $options = array()])

int insert (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

bool open (array $connection)

bool rollback ([array $options = array()])

array select (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

bool transaction ([array $options = array()])

int update (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

Variables

Inherited Variables

Inherited from BaseConnector

BaseConnector::$cache
BaseConnector::$conn
BaseConnector::$options

Methods

Constructor OdbcConnector (line 86)

Open a connection to a ODBC data source and set global options.

access: public

OdbcConnector OdbcConnector (array $connection, [array $options = array()])

array $connection: An associated array of connection settings, like database and user name.
array $options: An associated array of global options for the resulting instance.

build (line 474)

Add a TOP x statement to a SQL SELECT query when the IConnector::RESULT_LENGTH is set.

return: A modified SQL query.
access: protected

string build (string $query, [array $options = array()])

string $query: A SQL query to execute on a database.
array $options: An associated array of options.

commit (line 414)

Commits the current transaction on the current connection.

The current transaction includes all statements on the connection that were executed after the call to transaction() and before any calls to rollback() or commit().

return: true if the transaction was successfully committed, false otherwise.
see: IConnector::commit().
access: public

bool commit ([array $options = array()])

array $options: An associated array of options, see the Option elements.

Redefinition of:

BaseConnector::commit(): Commits the current transaction on the current connection.

Implementation of:

IConnector::commit(): Commits the current transaction on the current connection.

delete (line 334)

Send a SQL DELETE query to the database and get the number of rows deleted by the query.

return: The number of rows deleted by the query.
see: IConnector::delete().
throws: Exception when $param doesn't match the type definition $map.
access: public

int delete (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::delete(): Send a SQL DELETE query to the database and get the number of rows deleted by the query.

driver (line 542)

Get the driver name of a ODBC data source.

return: The driver name of the ODBC data source.
access: protected

string driver (string $name)

string $name: The currently used ODBC data source.

fetch (line 515)

Fetch multiple rows of a query result.

If the IConnector::RESULT_LENGTH or IConnector::RESULT_OFFSET options are set, some rows are omitted from the beginning and/or the end of the query result. If the IConnector::RESULT_KEY_FIELD option is set, the resulting table is an associated array of rows.

return: The query result as a table (array of associated arrays).
access: protected

array fetch (resource $stmt, [array $options = array()])

resource $stmt: A statement resource corresponding to an executed statement.
array $options: An associated array of options.

insert (line 217)

Send a SQL INSERT query to the database and get the IDENTITY ID generated from the last INSERT operation (if any).

return: The IDENTITY ID of the last inserted row.
see: IConnector::insert().
throws: Exception when $param doesn't match the type definition $map.
access: public

int insert (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::insert(): Send a SQL INSERT query to the database and get the IDENTITY ID generated from the last INSERT operation (if any).

open (line 116)

Open a database connection.

return: true, if a database connection was successfully opened, false otherwise.
access: protected

bool open (array $connection)

array $connection: An associated array of connection settings, like host and user name.

rollback (line 445)

Rolls back the current transaction on the current connection.

The current transaction includes all statements on the connection that were executed after the call to transaction() and before any calls to rollback() or commit().

return: true if the transaction was successfully rolled back, false otherwise.
see: IConnector::rollback().
access: public

bool rollback ([array $options = array()])

array $options: An associated array of options, see the Option elements.

Redefinition of:

BaseConnector::rollback(): Rolls back the current transaction on the current connection.

Implementation of:

IConnector::rollback(): Rolls back the current transaction on the current connection.

select (line 156)

Send a SQL SELECT query to the database and get the query result.

return: The query result as a table (array of associated arrays).
see: IConnector::select().
throws: Exception when $param doesn't match the type definition $map.
access: public

array select (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::select(): Send a SQL SELECT query to the database and get the query result.

transaction (line 383)

Begins a transaction on the current connection.

The current transaction includes all statements on the connection that were executed after the call to transaction() and before any calls to rollback() or commit().

return: true if the transaction was successfully begun, false otherwise.
see: IConnector::transaction().
access: public

bool transaction ([array $options = array()])

array $options: An associated array of options, see the Option elements.

Redefinition of:

BaseConnector::transaction(): Begins a transaction on the current connection.

Implementation of:

IConnector::transaction(): Begins a transaction on the current connection.

update (line 283)

Send a SQL UPDATE query to the database and get the number of rows updates by the query.

return: The number of rows updates by the query.
see: IConnector::update().
throws: Exception when $param doesn't match the type definition $map.
access: public

int update (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::update(): Send a SQL UPDATE query to the database and get the number of rows updates by the query.

Inherited Methods

Inherited From BaseConnector

BaseConnector::BaseConnector()
BaseConnector::bind()
BaseConnector::cast()
BaseConnector::castArray()
BaseConnector::castBool()
BaseConnector::castDate()
BaseConnector::castFloat()
BaseConnector::castInt()
BaseConnector::castNull()
BaseConnector::castNumeric()
BaseConnector::castObject()
BaseConnector::castString()
BaseConnector::commit()
BaseConnector::getCache()
BaseConnector::getHash()
BaseConnector::getLink()
BaseConnector::getOptions()
BaseConnector::lookup()
BaseConnector::push()
BaseConnector::rollback()
BaseConnector::setCache()
BaseConnector::setOptions()
BaseConnector::strDecode()
BaseConnector::strEncode()
BaseConnector::strEscape()
BaseConnector::strQuote()
BaseConnector::strStrip()
BaseConnector::transaction()

Class Constants

CONN_CURSOR = "connCursor" (line 58)

This option sets the type of cursor to be used for this odbc connection.

This option is not normally needed, but can be useful for working around problems with some odbc drivers.

This option can only be used as a constructor option. Valid values are the odbc cursor types. The default value is null (odbc default cursor).

DRIVER = "driver" (line 65)

Contains the driver name of the current ODBC data source.

DRIVER_MSSQL_NATIVE = "SQL Native Client" (line 72)

Currently supported ODBC drivers.

DRIVER_MSSQL_SERVER = "SQL Server" (line 73)

Currently supported ODBC drivers.

DRIVER_MYSQL = "MySQL ODBC 5.1 Driver" (line 74)

Currently supported ODBC drivers.