Docs For Class Zend_Db_Adapter

Zend_Db_Adapter_Abstract

Description

Class for connecting to SQL databases and performing common operations.

abstract:
license: Zend
copyright: Copyright (c) 2005-2006 Zend Technologies Inc. (http://www.zend.com)

Located in /library/Zend/Db/Adapter/Abstract.php (line 39)

Direct descendents

Class	Description
Zend_Db_Adapter_Oracle
Zend_Db_Adapter_Pdo_Abstract	Class for connecting to SQL databases and performing common operations using PDO.

Variable Summary

array $_config

object|resource|null $_connection

integer $_fetchMode

Zend_Db_Profiler $_profiler

Method Summary

Zend_Db_Adapter_Abstract __construct (array $config)

void beginTransaction ()

void commit ()

int delete (string $table, string $where)

array describeTable (mixed $table)

array fetchAll (string $sql, [array $bind = null])

string fetchAssoc (string $sql, [array $bind = null])

array fetchCol (string $sql, [array $bind = null])

string fetchOne (string $sql, [array $bind = null])

string fetchPairs (string $sql, [array $bind = null])

array fetchRow (string $sql, [array $bind = null])

object|resource|null getConnection ()

int getFetchMode ()

Zend_Db_Profiler getProfiler ()

int insert (string $table, array $bind)

integer lastInsertId ([string $name = null])

string limit (mixed $sql, mixed $count, mixed $offset)

array listTables ()

Zend_Db_Statment|PDOStatement prepare (string $sql)

Zend_Db_Statement query (string $sql, [array $bind = array()])

mixed quote (mixed $value)

string quoteIdentifier (mixed $string, string $ident)

mixed quoteInto (mixed $text, mixed $value, string $txt, mixed $val)

void rollBack ()

Zend_Db_Select select ()

void setFetchMode (integer $mode)

int update (string $table, array $bind, string $where)

void _beginTransaction ()

void _commit ()

void _connect ()

string _quote (string $value)

void _rollBack ()

Variables

array $_config = array() (line 47)

User-provided configuration

access: protected

Redefined in descendants as:

Zend_Db_Adapter_Oracle::$_config : User-provided configuration.

object|resource|null $_connection = null (line 68)

Database connection

access: protected

integer $_fetchMode = Zend_Db::FETCH_ASSOC (line 54)

Fetch mode

access: protected

Zend_Db_Profiler $_profiler (line 61)

Query profiler

access: protected

Methods

Constructor __construct (line 84)

Constructor.

$config is an array of key/value pairs containing configuration options. These options are common to most adapters:

username => (string) Connect to the database as this username. password => (string) Password associated with the username. host => (string) What host to connect to (default 127.0.0.1) dbname => (string) The name of the database to user

access: public

Zend_Db_Adapter_Abstract __construct (array $config)

array $config: An array of configuration keys.

Redefined in descendants as:

Zend_Db_Adapter_Oracle::__construct() : Constructor.

beginTransaction (line 167)

Leave autocommit mode and begin a transaction.

access: public

void beginTransaction ()

commit (line 181)

Commit a transaction and return to autocommit mode.

access: public

void commit ()

delete (line 263)

Deletes table rows based on a WHERE clause.

return: The number of affected rows.
access: public

int delete (string $table, string $where)

string $table: The table to udpate.
string $where: DELETE WHERE clause.

describeTable (line 471)

Returns the column descriptions for a table.

access: public
abstract:

array describeTable (mixed $table)

Redefined in descendants as:

Zend_Db_Adapter_Oracle::describeTable() : Returns the column descriptions for a table.
Zend_Db_Adapter_Pdo_Mssql::describeTable() : Returns the column descriptions for a table.
Zend_Db_Adapter_Pdo_Mysql::describeTable() : Returns the column descriptions for a table.
Zend_Db_Adapter_Pdo_Pgsql::describeTable() : Returns the column descriptions for a table.
Zend_Db_Adapter_Pdo_Sqlite::describeTable() : Returns the column descriptions for a table.

fetchAll (line 304)

Fetches all SQL result rows as a sequential array.

access: public

array fetchAll (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

fetchAssoc (line 321)

Fetches all SQL result rows as an associative array.

The first column is the key, the entire row array is the value.

access: public

string fetchAssoc (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

fetchCol (line 342)

Fetches the first column of all SQL result rows as an array.

The first column in each row is used as the array key.

access: public

array fetchCol (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

fetchOne (line 377)

Fetches the first column of the first row of the SQL result.

access: public

string fetchOne (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

fetchPairs (line 359)

Fetches all SQL result rows as an array of key-value pairs.

The first column is the key, the second column is the value.

access: public

string fetchPairs (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

fetchRow (line 391)

Fetches the first row of the SQL result.

access: public

array fetchRow (string $sql, [array $bind = null])

string $sql: An SQL SELECT statement.
array $bind: Data to bind into SELECT placeholders.

getConnection (line 116)

Returns the underlying database connection object or resource. If not presently connected, this may return null.

access: public

object|resource|null getConnection ()

getFetchMode (line 291)

Get the fetch mode.

access: public

int getFetchMode ()

getProfiler (line 127)

Returns the profiler for this adapter.

access: public

Zend_Db_Profiler getProfiler ()

insert (line 213)

Inserts a table row with specified data.

return: The number of affected rows.
access: public

int insert (string $table, array $bind)

string $table: The table to insert data into.
array $bind: Column-value pairs.

lastInsertId (line 506)

Gets the last inserted ID.

access: public
abstract:

integer lastInsertId ([string $name = null])

string $name: Sequence name

Redefined in descendants as:

Zend_Db_Adapter_Oracle::lastInsertId() : Gets the last inserted ID.
Zend_Db_Adapter_Pdo_Abstract::lastInsertId() : Gets the last inserted ID.

limit (line 541)

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

access: public
abstract:

string limit (mixed $sql, mixed $count, mixed $offset)

Redefined in descendants as:

Zend_Db_Adapter_Oracle::limit() : Adds an adapter-specific LIMIT clause to the SELECT statement.
Zend_Db_Adapter_Pdo_Mssql::limit() : Adds an adapter-specific LIMIT clause to the SELECT statement.
Zend_Db_Adapter_Pdo_Mysql::limit() : Adds an adapter-specific LIMIT clause to the SELECT statement.
Zend_Db_Adapter_Pdo_Pgsql::limit() : Adds an adapter-specific LIMIT clause to the SELECT statement.
Zend_Db_Adapter_Pdo_Sqlite::limit() : Adds an adapter-specific LIMIT clause to the SELECT statement.

listTables (line 463)

Returns a list of the tables in the database.

access: public
abstract:

array listTables ()

Redefined in descendants as:

Zend_Db_Adapter_Oracle::listTables() : Returns a list of the tables in the database.
Zend_Db_Adapter_Pdo_Mssql::listTables() : Returns a list of the tables in the database.
Zend_Db_Adapter_Pdo_Mysql::listTables() : Returns a list of the tables in the database.
Zend_Db_Adapter_Pdo_Pgsql::listTables() : Returns a list of the tables in the database.
Zend_Db_Adapter_Pdo_Sqlite::listTables() : Returns a list of the tables in the database.

prepare (line 497)

Prepare a statement and return a PDOStatement-like object.

access: public
abstract:

Zend_Db_Statment|PDOStatement prepare (string $sql)

string $sql: SQL query

Redefined in descendants as:

Zend_Db_Adapter_Oracle::prepare() : Returns an SQL statement for preparation.
Zend_Db_Adapter_Pdo_Abstract::prepare() : Prepares an SQL statement.

query (line 140)

Prepares and executes an SQL statement with bound data.

return: (may also be PDOStatement in the case of PDO)
access: public

Zend_Db_Statement query (string $sql, [array $bind = array()])

string $sql: The SQL statement with placeholders.
array $bind: An array of data to bind to the placeholders.

quote (line 407)

Safely quotes a value for an SQL statement.

If an array is passed as the value, the array values are quoted and then returned as a comma-separated string.

return: An SQL-safe quoted value (or string of separated values).
access: public

mixed quote (mixed $value)

mixed $value: The value to quote.

quoteIdentifier (line 455)

Quotes an identifier.

return: The quoted identifier.
access: public
abstract:

string quoteIdentifier (mixed $string, string $ident)

string $ident: The identifier.

Redefined in descendants as:

Zend_Db_Adapter_Oracle::quoteIdentifier() : Quotes an identifier.
Zend_Db_Adapter_Pdo_Mssql::quoteIdentifier() : Quotes an identifier.
Zend_Db_Adapter_Pdo_Mysql::quoteIdentifier() : Quotes an identifier.
Zend_Db_Adapter_Pdo_Pgsql::quoteIdentifier() : Quotes an identifier.
Zend_Db_Adapter_Pdo_Sqlite::quoteIdentifier() : Quotes an identifier.

quoteInto (line 438)

Quotes a value and places into a piece of text at a placeholder.

The placeholder is a question-mark; all placeholders will be replaced with the quoted value. For example:

 $text = "WHERE date < ?";
 $date = "2005-01-02";
 $safe = $sql->quoteInto($text, $date);
 // $safe = "WHERE date < '2005-01-02'"

return: An SQL-safe quoted value placed into the orignal text.
access: public

mixed quoteInto (mixed $text, mixed $value, string $txt, mixed $val)

string $txt: The text with a placeholder.
mixed $val: The value to quote.

rollBack (line 196)

Roll back a transaction and return to autocommit mode.

access: public

void rollBack ()

select (line 280)

Creates and returns a new Zend_Db_Select object for this adapter.

access: public

Zend_Db_Select select ()

setFetchMode (line 532)

Set the fetch mode.

access: public
abstract:

void setFetchMode (integer $mode)

integer $mode

Redefined in descendants as:

Zend_Db_Adapter_Oracle::setFetchMode() : Set the fetch mode.
Zend_Db_Adapter_Pdo_Abstract::setFetchMode() : Set the PDO fetch mode.

update (line 237)

Updates table rows with specified data based on a WHERE clause.

return: The number of affected rows.
access: public

int update (string $table, array $bind, string $where)

string $table: The table to udpate.
array $bind: Column-value pairs.
string $where: UPDATE WHERE clause.

_beginTransaction (line 512)

Begin a transaction.

access: protected
abstract:

void _beginTransaction ()

Redefined in descendants as:

Zend_Db_Adapter_Oracle::_beginTransaction() : Leave autocommit mode and begin a transaction.
Zend_Db_Adapter_Pdo_Abstract::_beginTransaction() : Begin a transaction.

_commit (line 518)

Commit a transaction.

access: protected
abstract:

void _commit ()

Redefined in descendants as:

Zend_Db_Adapter_Oracle::_commit() : Commit a transaction and return to autocommit mode.
Zend_Db_Adapter_Pdo_Abstract::_commit() : Commit a transaction.

_connect (line 488)

Creates a connection to the database.

access: protected
abstract:

void _connect ()

Redefined in descendants as:

Zend_Db_Adapter_Oracle::_connect() : Creates a connection resource.
Zend_Db_Adapter_Pdo_Abstract::_connect() : Creates a PDO object and connects to the database.

_quote (line 480)

Quote a raw string.

return: Quoted string
access: protected
abstract:

string _quote (string $value)

string $value: Raw string

Redefined in descendants as:

Zend_Db_Adapter_Oracle::_quote() : Quote a raw string.
Zend_Db_Adapter_Pdo_Abstract::_quote() : Quote a raw string.

_rollBack (line 524)

Roll-back a transaction.

access: protected
abstract:

void _rollBack ()

Redefined in descendants as:

Zend_Db_Adapter_Oracle::_rollBack() : Roll back a transaction and return to autocommit mode.
Zend_Db_Adapter_Pdo_Abstract::_rollBack() : Roll-back a transaction.

Documentation generated on Wed, 08 Mar 2006 04:50:54 -0800 by phpDocumentor 1.3.0RC4