Abstract Class Zend_Db_Adapter_Abstract

Description

Class for connecting to SQL databases and performing common operations.

  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • abstract:
  • license: New BSD License

Located in /Db/Adapter/Abstract.php (line 50)


	
			
Direct descendents
Class Description
 class Zend_Db_Adapter_Db2
 class Zend_Db_Adapter_Mysqli
 class Zend_Db_Adapter_Oracle
Abstract class 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
Method Summary
 Zend_Db_Adapter_Abstract __construct ([ $config = array()])
 void closeConnection ()
 bool commit ()
 int delete (mixed $table, [mixed $where = ''])
 array describeTable (string $tableName, [string $schemaName = null])
 array fetchAll (string|Zend_Db_Select $sql, [mixed $bind = array()])
 string fetchAssoc (string|Zend_Db_Select $sql, [mixed $bind = array()])
 array fetchCol (string|Zend_Db_Select $sql, [mixed $bind = array()])
 string fetchOne (string|Zend_Db_Select $sql, [mixed $bind = array()])
 string fetchPairs (string|Zend_Db_Select $sql, [mixed $bind = array()])
 array fetchRow (string|Zend_Db_Select $sql, [mixed $bind = array()])
 string foldCase (string $key)
 object|resource|null getConnection ()
 int getFetchMode ()
 int insert (mixed $table,  $bind)
 integer lastInsertId ([string $tableName = null], [string $primaryKey = null])
 integer lastSequenceId (string $sequenceName)
 string limit (mixed $sql, integer $count, [integer $offset = 0])
 array listTables ()
 integer nextSequenceId (string $sequenceName)
 Zend_Db_Statment|PDOStatement prepare (string|Zend_Db_Select $sql)
 Zend_Db_Statement_Interface query (mixed $sql, [mixed $bind = array()])
 mixed quote (mixed $value)
 string quoteColumnAs (string|array|Zend_Db_Expr $ident, string $alias)
 string quoteIdentifier (string|array|Zend_Db_Expr $ident)
 mixed quoteInto (string $text, mixed $value)
 string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
 bool rollBack ()
 void setFetchMode (integer $mode)
 int update (mixed $table,  $bind, [mixed $where = ''])
 void _checkRequiredOptions ( $config)
 void _commit ()
 void _connect ()
 string _quote (string $value)
 string _quoteIdentifier (string $value)
 string _quoteIdentifierAs (string|array|Zend_Db_Expr $ident, [string $alias = null], [string $as = ' AS '])
 void _rollBack ()
 string _whereExpr (mixed $where)
Variables
mixed $_caseFolding = Zend_Db::CASE_NATURAL (line 90)

Specifies the case of column names retrieved in queries

Options Zend_Db::CASE_NATURAL (default) Zend_Db::CASE_LOWER Zend_Db::CASE_UPPER

  • access: protected
array $_config = array() (line 58)

User-provided configuration

  • access: protected

Redefined in descendants as:
object|resource|null $_connection = null (line 79)

Database connection

  • access: protected
integer $_fetchMode = Zend_Db::FETCH_ASSOC (line 65)

Fetch mode

  • access: protected
Zend_Db_Profiler $_profiler (line 72)

Query profiler

  • access: protected
Methods
Constructor __construct (line 113)

Constructor.

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

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

Some options are used on a case-by-case basis by adapters:

port => (string) The port of the database persistent => (boolean) Whether to use a persistent connection or not, defaults to false protocol => (string) The network protocol, defaults to TCPIP caseFolding => (int)

  • throws: Zend_Db_Adapter_Exception
  • access: public
Zend_Db_Adapter_Abstract __construct ([ $config = array()])
  • array $config: An array of configuration keys.

Redefined in descendants as:
beginTransaction (line 246)

Leave autocommit mode and begin a transaction.

  • return: True
  • access: public
bool beginTransaction ()
closeConnection (line 807)

Force the connection to close.

  • abstract:
  • access: public
void closeConnection ()

Redefined in descendants as:
commit (line 260)

Commit a transaction and return to autocommit mode.

  • return: True
  • access: public
bool commit ()
delete (line 367)

Deletes table rows based on a WHERE clause.

  • return: The number of affected rows.
  • access: public
int delete (mixed $table, [mixed $where = ''])
  • mixed $table: The table to update.
  • mixed $where: DELETE WHERE clause(s).
describeTable (line 793)

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

  • abstract:
  • access: public
array describeTable (string $tableName, [string $schemaName = null])
  • string $tableName
  • string $schemaName: OPTIONAL

Redefined in descendants as:
fetchAll (line 439)

Fetches all SQL result rows as a sequential array.

Uses the current fetchMode for the adapter.

  • access: public
array fetchAll (string|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
fetchAssoc (line 456)

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|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
fetchCol (line 476)

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|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
fetchOne (line 510)

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

  • access: public
string fetchOne (string|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
fetchPairs (line 493)

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|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
fetchRow (line 525)

Fetches the first row of the SQL result.

Uses the current fetchMode for the adapter.

  • access: public
array fetchRow (string|Zend_Db_Select $sql, [mixed $bind = array()])
  • string|Zend_Db_Select $sql: An SQL SELECT statement.
  • mixed $bind: Data to bind into SELECT placeholders.
foldCase (line 742)

Helper method to change the case of the strings used when returning result sets in FETCH_ASSOC and FETCH_BOTH modes.

This is not intended to be used by application code, but the method must be public so the Statement class can invoke it.

  • access: public
string foldCase (string $key)
  • string $key
getConnection (line 189)

Returns the underlying database connection object or resource.

If not presently connected, this initiates the connection.

  • access: public
object|resource|null getConnection ()
getFetchMode (line 426)

Get the fetch mode.

  • access: public
int getFetchMode ()
getProfiler (line 200)

Returns the profiler for this adapter.

  • access: public
Zend_Db_Profiler getProfiler ()
getQuoteIdentifierSymbol (line 699)

Returns the symbol the adapter uses for delimited identifiers.

  • access: public
string getQuoteIdentifierSymbol ()

Redefined in descendants as:
insert (line 290)

Inserts a table row with specified data.

  • return: The number of affected rows.
  • access: public
int insert (mixed $table,  $bind)
  • mixed $table: The table to insert data into.
  • array $bind: Column-value pairs.

Redefined in descendants as:
lastInsertId (line 831)

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.

  • abstract:
  • access: public
integer lastInsertId ([string $tableName = null], [string $primaryKey = null])
  • string $tableName: OPTIONAL Name of table.
  • string $primaryKey: OPTIONAL Name of primary key column.

Redefined in descendants as:
lastSequenceId (line 712)

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

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

  • access: public
integer lastSequenceId (string $sequenceName)
  • string $sequenceName

Redefined in descendants as:
limit (line 863)

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

  • abstract:
  • access: public
string limit (mixed $sql, integer $count, [integer $offset = 0])
  • mixed $sql
  • integer $count
  • integer $offset

Redefined in descendants as:
listTables (line 764)

Returns a list of the tables in the database.

  • abstract:
  • access: public
array listTables ()

Redefined in descendants as:
nextSequenceId (line 725)

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

This is supported only on RDBMS brands that support sequences (e.g. Oracle, PostgreSQL, DB2). Other RDBMS brands return null.

  • access: public
integer nextSequenceId (string $sequenceName)
  • string $sequenceName

Redefined in descendants as:
prepare (line 815)

Prepare a statement and return a PDOStatement-like object.

  • abstract:
  • access: public
Zend_Db_Statment|PDOStatement prepare (string|Zend_Db_Select $sql)

Redefined in descendants as:
query (line 213)

Prepares and executes an SQL statement with bound data.

  • access: public
Zend_Db_Statement_Interface query (mixed $sql, [mixed $bind = array()])
  • mixed $sql: The SQL statement with placeholders. May be a string or Zend_Db_Select.
  • mixed $bind: An array of data to bind to the placeholders.

Redefined in descendants as:
quote (line 552)

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.
quoteColumnAs (line 626)

Quote a column identifier and alias.

  • return: The quoted identifier and alias.
  • access: public
string quoteColumnAs (string|array|Zend_Db_Expr $ident, string $alias)
  • string|array|Zend_Db_Expr $ident: The identifier or expression.
  • string $alias: An alias for the column.
quoteIdentifier (line 614)

Quotes an identifier.

Accepts a string representing a qualified indentifier. For Example:

  1.  $adapter->quoteIdentifier('myschema.mytable')
Returns: "myschema"."mytable"

Or, an array of one or more identifiers that may form a qualified identifier:

  1.  $adapter->quoteIdentifier(array('myschema','my.table'))
Returns: "myschema"."my.table"

The actual quote character surrounding the identifiers may vary depending on the adapter.

  • return: The quoted identifier.
  • access: public
string quoteIdentifier (string|array|Zend_Db_Expr $ident)
quoteInto (line 588)

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:

  1.  $text "WHERE date < ?";
  2.  $date "2005-01-02";
  3.  $safe $sql->quoteInto($text$date);
  4.  // $safe = "WHERE date < '2005-01-02'"

  • return: An SQL-safe quoted value placed into the orignal text.
  • access: public
mixed quoteInto (string $text, mixed $value)
  • string $text: The text with a placeholder.
  • mixed $value: The value to quote.
quoteTableAs (line 638)

Quote a table identifier and alias.

  • return: The quoted identifier and alias.
  • access: public
string quoteTableAs (string|array|Zend_Db_Expr $ident, string $alias)
  • string|array|Zend_Db_Expr $ident: The identifier or expression.
  • string $alias: An alias for the table.

Redefined in descendants as:
rollBack (line 274)

Roll back a transaction and return to autocommit mode.

  • return: True
  • access: public
bool rollBack ()
select (line 416)

Creates and returns a new Zend_Db_Select object for this adapter.

  • access: public
Zend_Db_Select select ()
setFetchMode (line 853)

Set the fetch mode.

  • abstract:
  • access: public
void setFetchMode (integer $mode)
  • integer $mode

Redefined in descendants as:
update (line 325)

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

  • return: The number of affected rows.
  • access: public
int update (mixed $table,  $bind, [mixed $where = ''])
  • mixed $table: The table to update.
  • array $bind: Column-value pairs.
  • mixed $where: UPDATE WHERE clause(s).

Redefined in descendants as:
_beginTransaction (line 836)

Begin a transaction.

  • abstract:
  • access: protected
void _beginTransaction ()

Redefined in descendants as:
_checkRequiredOptions (line 158)

Check for config options that are mandatory.

Throw exceptions if any are missing.

  • throws: Zend_Db_Adapter_Exception
  • access: protected
void _checkRequiredOptions ( $config)
  • array $config

Redefined in descendants as:
_commit (line 841)

Commit a transaction.

  • abstract:
  • access: protected
void _commit ()

Redefined in descendants as:
_connect (line 800)

Creates a connection to the database.

  • abstract:
  • access: protected
void _connect ()

Redefined in descendants as:
_quote (line 538)

Quote a raw string.

  • return: Quoted string
  • access: protected
string _quote (string $value)
  • string $value: Raw string

Redefined in descendants as:
_quoteIdentifier (line 688)

Quote an identifier.

  • return: The quoted identifier and alias.
  • access: protected
string _quoteIdentifier (string $value)
  • string $value: The identifier or expression.

Redefined in descendants as:
_quoteIdentifierAs (line 651)

Quote an identifier and an optional alias.

  • return: The quoted identifier and alias.
  • access: protected
string _quoteIdentifierAs (string|array|Zend_Db_Expr $ident, [string $alias = null], [string $as = ' AS '])
  • string|array|Zend_Db_Expr $ident: The identifier or expression.
  • string $alias: An optional alias.
  • string $as: The string to add between the identifier/expression and the alias.
_rollBack (line 846)

Roll-back a transaction.

  • abstract:
  • access: protected
void _rollBack ()

Redefined in descendants as:
_whereExpr (line 393)

Convert an array, string, or Zend_Db_Expr object into a string to put in a WHERE clause.

  • access: protected
string _whereExpr (mixed $where)
  • mixed $where

Documentation generated on Sun, 27 May 2007 23:19:59 -0700 by phpDocumentor 1.3.2