Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Db_Adapter_Pdo_Abstract Class Reference

Public Member Functions

 isConnected ()
 Test if a connection is active.
 
 closeConnection ()
 Force the connection to close.
 
 prepare ($sql)
 Prepares an SQL statement.
 
 lastInsertId ($tableName=null, $primaryKey=null)
 Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
 
 query ($sql, $bind=array())
 Special handling for PDO query().
 
 exec ($sql)
 Executes an SQL statement and return the number of affected rows.
 
 setFetchMode ($mode)
 Set the PDO fetch mode.
 
 supportsParameters ($type)
 Check if the adapter supports real SQL parameters.
 
 getServerVersion ()
 Retrieve server version in PHP style.
 
- Public Member Functions inherited from Zend_Db_Adapter_Abstract
 __construct ($config)
 Constructor.
 
 getConnection ()
 Returns the underlying database connection object or resource.
 
 getConfig ()
 Returns the configuration variables in this adapter.
 
 setProfiler ($profiler)
 Set the adapter's profiler object.
 
 getProfiler ()
 Returns the profiler for this adapter.
 
 getStatementClass ()
 Get the default statement class.
 
 setStatementClass ($class)
 Set the default statement class.
 
 query ($sql, $bind=array())
 Prepares and executes an SQL statement with bound data.
 
 beginTransaction ()
 Leave autocommit mode and begin a transaction.
 
 commit ()
 Commit a transaction and return to autocommit mode.
 
 rollBack ()
 Roll back a transaction and return to autocommit mode.
 
 insert ($table, array $bind)
 Inserts a table row with specified data.
 
 update ($table, array $bind, $where= '')
 Updates table rows with specified data based on a WHERE clause.
 
 delete ($table, $where= '')
 Deletes table rows based on a WHERE clause.
 
 select ()
 Creates and returns a new Zend_Db_Select object for this adapter.
 
 getFetchMode ()
 Get the fetch mode.
 
 fetchAll ($sql, $bind=array(), $fetchMode=null)
 Fetches all SQL result rows as a sequential array.
 
 fetchRow ($sql, $bind=array(), $fetchMode=null)
 Fetches the first row of the SQL result.
 
 fetchAssoc ($sql, $bind=array())
 Fetches all SQL result rows as an associative array.
 
 fetchCol ($sql, $bind=array())
 Fetches the first column of all SQL result rows as an array.
 
 fetchPairs ($sql, $bind=array())
 Fetches all SQL result rows as an array of key-value pairs.
 
 fetchOne ($sql, $bind=array())
 Fetches the first column of the first row of the SQL result.
 
 quote ($value, $type=null)
 Safely quotes a value for an SQL statement.
 
 quoteInto ($text, $value, $type=null, $count=null)
 Quotes a value and places into a piece of text at a placeholder.
 
 quoteIdentifier ($ident, $auto=false)
 Quotes an identifier.
 
 quoteColumnAs ($ident, $alias, $auto=false)
 Quote a column identifier and alias.
 
 quoteTableAs ($ident, $alias=null, $auto=false)
 Quote a table identifier and alias.
 
 getQuoteIdentifierSymbol ()
 Returns the symbol the adapter uses for delimited identifiers.
 
 lastSequenceId ($sequenceName)
 Return the most recent value from the specified sequence in the database.
 
 nextSequenceId ($sequenceName)
 Generate a new value from the specified sequence in the database, and return it.
 
 foldCase ($key)
 Helper method to change the case of the strings used when returning result sets in FETCH_ASSOC and FETCH_BOTH modes.
 
 __sleep ()
 called when object is getting serialized This disconnects the DB object that cant be serialized
 
 __wakeup ()
 called when object is getting unserialized
 
 listTables ()
 Abstract Methods.
 
 describeTable ($tableName, $schemaName=null)
 Returns the column descriptions for a table.
 
 isConnected ()
 Test if a connection is active.
 
 closeConnection ()
 Force the connection to close.
 
 prepare ($sql)
 Prepare a statement and return a PDOStatement-like object.
 
 lastInsertId ($tableName=null, $primaryKey=null)
 Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.
 
 setFetchMode ($mode)
 Set the fetch mode.
 
 limit ($sql, $count, $offset=0)
 Adds an adapter-specific LIMIT clause to the SELECT statement.
 
 supportsParameters ($type)
 Check if the adapter supports real SQL parameters.
 
 getServerVersion ()
 Retrieve server version in PHP style.
 

Protected Member Functions

 _dsn ()
 Creates a PDO DSN for the adapter from $this->_config settings.
 
 _connect ()
 Creates a PDO object and connects to the database.
 
 _quote ($value)
 Quote a raw string.
 
 _beginTransaction ()
 Begin a transaction.
 
 _commit ()
 Commit a transaction.
 
 _rollBack ()
 Roll-back a transaction.
 
- Protected Member Functions inherited from Zend_Db_Adapter_Abstract
 _checkRequiredOptions (array $config)
 Check for config options that are mandatory.
 
 _whereExpr ($where)
 Convert an array, string, or Zend_Db_Expr object into a string to put in a WHERE clause.
 
 _quote ($value)
 Quote a raw string.
 
 _quoteIdentifierAs ($ident, $alias=null, $auto=false, $as= 'AS ')
 Quote an identifier and an optional alias.
 
 _quoteIdentifier ($value, $auto=false)
 Quote an identifier.
 
 _connect ()
 Creates a connection to the database.
 
 _beginTransaction ()
 Begin a transaction.
 
 _commit ()
 Commit a transaction.
 
 _rollBack ()
 Roll-back a transaction.
 

Protected Attributes

 $_defaultStmtClass = 'Zend_Db_Statement_Pdo'
 
- Protected Attributes inherited from Zend_Db_Adapter_Abstract
 $_config = array()
 
 $_fetchMode = Zend_Db::FETCH_ASSOC
 
 $_profiler
 
 $_defaultStmtClass = 'Zend_Db_Statement'
 
 $_defaultProfilerClass = 'Zend_Db_Profiler'
 
 $_connection = null
 
 $_caseFolding = Zend_Db::CASE_NATURAL
 
 $_autoQuoteIdentifiers = true
 
 $_numericDataTypes
 
 $_allowSerialization = true
 
 $_autoReconnectOnUnserialize = false
 

Member Function Documentation

_beginTransaction ( )
protected

Begin a transaction.

_commit ( )
protected

Commit a transaction.

_connect ( )
protected

Creates a PDO object and connects to the database.

Returns
void
Exceptions
Zend_Db_Adapter_Exception
See Also
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
_dsn ( )
protected

Creates a PDO DSN for the adapter from $this->_config settings.

Returns
string
_quote (   $value)
protected

Quote a raw string.

Parameters
string$valueRaw string
Returns
string Quoted string
_rollBack ( )
protected

Roll-back a transaction.

closeConnection ( )

Force the connection to close.

Returns
void
exec (   $sql)

Executes an SQL statement and return the number of affected rows.

Parameters
mixed$sqlThe SQL statement with placeholders. May be a string or Zend_Db_Select.
Returns
integer Number of rows that were modified or deleted by the SQL statement
See Also
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
getServerVersion ( )

Retrieve server version in PHP style.

Returns
string
isConnected ( )

Test if a connection is active.

Returns
boolean
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.

On RDBMS brands that don't support sequences, $tableName and $primaryKey are ignored.

Parameters
string$tableNameOPTIONAL Name of table.
string$primaryKeyOPTIONAL Name of primary key column.
Returns
string
prepare (   $sql)

Prepares an SQL statement.

Parameters
string$sqlThe SQL statement with placeholders.
array$bindAn array of data to bind to the placeholders.
Returns
PDOStatement
query (   $sql,
  $bind = array() 
)

Special handling for PDO query().

All bind parameter names must begin with ':'

Parameters
string | Zend_Db_Select$sqlThe SQL statement with placeholders.
array$bindAn array of data to bind to the placeholders.
Returns
Zend_Db_Statement_Pdo
Exceptions
Zend_Db_Adapter_ExceptionTo re-throw PDOException.
See Also
Zend_Db_Statement_Exception
setFetchMode (   $mode)

Set the PDO fetch mode.

Todo:
Support FETCH_CLASS and FETCH_INTO.
Parameters
int$modeA PDO fetch mode.
Returns
void
Exceptions
Zend_Db_Adapter_Exception
See Also
Zend_Db_Adapter_Exception
Zend_Db_Adapter_Exception
supportsParameters (   $type)

Check if the adapter supports real SQL parameters.

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

Member Data Documentation

$_defaultStmtClass = 'Zend_Db_Statement_Pdo'
protected