Docs For Class Zend_Db_Statement

## Class Zend_Db_Statement

Description

Implements interfaces:

- Zend_Db_Statement_Interface

Abstract class to emulate a PDOStatement for native database adapters.

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

Located in /Zend/Db/Statement.php (line 38)

Direct descendents

Class | Description
--- | ---
Zend_Db_Statement_Mysqli | Extends for Mysqli
Zend_Db_Statement_Oracle | Extends for Oracle.
Zend_Db_Statement_Db2 | Extends for DB2.

Variable Summary
mixed $_attribute
mixed $_bindColumn
mixed $_bindParam
mixed $_fetchMode
mixed $_sqlParam
mixed $_sqlSplit
Method Summary
Zend_Db_Statement __construct ( $connection, $sql)
void bindColumn ( $column, &$param, [ $type = null])
void bindParam ( $parameter, &$variable, [ $type = null], [ $length = null], [ $options = null])
void bindValue ( $parameter, $value, [ $type = null])
void closeCursor ()
void columnCount ()
void errorCode ()
void errorInfo ()
void execute ([ $params = null])
void fetch ([ $style = null], [ $cursor = null], [ $offset = null])
void fetchAll ([ $style = null], [ $col = null])
void fetchColumn ([ $col = 0])
void fetchObject ([ $class = 'stdClass'], [ $config = null])
void getAttribute ( $key)
void nextRowset ()
void rowCount ()
void setAttribute ( $key, $val)
void setFetchMode ( $mode)
void _joinSql ()
void _prepSql ( $sql)
Variables
mixed $_attribute = array() (line 48)

Attributes.

- access: protected

mixed $_bindColumn = array() (line 53)

Column result bindings.

- access: protected

mixed $_bindParam = array() (line 58)

Query parameter bindings; covers bindParam() and bindValue().

- access: protected

mixed $_fetchMode = Zend_Db::FETCH_ASSOC (line 43)

The current fetch mode.

- access: protected

mixed $_sqlParam = array() (line 68)

Parameter placeholders in the SQL string by position in the split array.

- access: protected

mixed $_sqlSplit = array() (line 63)

SQL string split into an array at placeholders.

- access: protected

Methods
Constructor __construct (line 74)

Constructor.

- access: public

Zend_Db_Statement __construct ( $connection, $sql)

- $connection
- $sql

bindColumn (line 124)

binds a PHP variable to an output column in a result set

- access: public

void bindColumn ( $column, &$param, [ $type = null])

- $column
- &$param
- $type

Implementation of:

Zend_Db_Statement_Interface::bindColumn()
  binds a PHP variable to an output column in a result set

bindParam (line 133)

binds a PHP variable to a parameter in the prepared statement

- access: public

void bindParam ( $parameter, &$variable, [ $type = null], [ $length = null], [ $options = null])

- $parameter
- &$variable
- $type
- $length
- $options

Implementation of:

Zend_Db_Statement_Interface::bindParam()
  binds a PHP variable to a parameter in the prepared statement

Redefined in descendants as:

- Zend_Db_Statement_Oracle::bindParam() : binds a PHP variable to a parameter in the prepared statement
- Zend_Db_Statement_Db2::bindParam()

bindValue (line 272)

binds a value to a parameter in the prepared statement

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void bindValue ( $parameter, $value, [ $type = null])

- $parameter
- $value
- $type

Implementation of:

Zend_Db_Statement_Interface::bindValue()
  binds a value to a parameter in the prepared statement

closeCursor (line 283)

closes the cursor, allowing the statement to be executed again

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void closeCursor ()

Implementation of:

Zend_Db_Statement_Interface::closeCursor()
  closes the cursor, allowing the statement to be executed again

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::closeCursor() : closes the cursor, allowing the statement to be executed again
- Zend_Db_Statement_Oracle::closeCursor() : closes the cursor, allowing the statement to be executed again
- Zend_Db_Statement_Db2::closeCursor() : closes the cursor, allowing the statement to be executed again

columnCount (line 294)

returns the number of columns in the result set

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void columnCount ()

Implementation of:

Zend_Db_Statement_Interface::columnCount()
  returns the number of columns in the result set

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::columnCount() : returns the number of columns in the result set
- Zend_Db_Statement_Oracle::columnCount() : returns the number of columns in the result set
- Zend_Db_Statement_Db2::columnCount() : returns the number of columns in the result set

errorCode (line 305)

retrieves an error code, if any, from the statement

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void errorCode ()

Implementation of:

Zend_Db_Statement_Interface::errorCode()
  retrieves an error code, if any, from the statement

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::errorCode() : retrieves an error code, if any, from the statement
- Zend_Db_Statement_Oracle::errorCode() : retrieves an error code, if any, from the statement
- Zend_Db_Statement_Db2::errorCode() : retrieves a sql state, if any, from the statement

errorInfo (line 316)

retrieves an array of error information, if any, from the statement

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void errorInfo ()

Implementation of:

Zend_Db_Statement_Interface::errorInfo()
  retrieves an array of error information, if any, from the statement

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::errorInfo() : retrieves an array of error information, if any, from the statement
- Zend_Db_Statement_Oracle::errorInfo() : retrieves an array of error information, if any, from the statement
- Zend_Db_Statement_Db2::errorInfo() : retrieves a error msg, if any, from the statement

execute (line 327)

executes a prepared statement

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void execute ([ $params = null])

- $params

Implementation of:

Zend_Db_Statement_Interface::execute()
  executes a prepared statement

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::execute() : executes a prepared statement
- Zend_Db_Statement_Oracle::execute() : executes a prepared statement
- Zend_Db_Statement_Db2::execute() : executes a prepared statement

fetch (line 338)

fetches a row from a result set

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void fetch ([ $style = null], [ $cursor = null], [ $offset = null])

- $style
- $cursor
- $offset

Implementation of:

Zend_Db_Statement_Interface::fetch()
  fetches a row from a result set

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::fetch() : fetches a row from the result set
- Zend_Db_Statement_Oracle::fetch() : fetches a row from the result set
- Zend_Db_Statement_Db2::fetch() : fetches a row from a result set

fetchAll (line 162)

fetches an array containing all of the rows from a result set

- access: public

void fetchAll ([ $style = null], [ $col = null])

- $style
- $col

Implementation of:

Zend_Db_Statement_Interface::fetchAll()
  fetches an array containing all of the rows from a result set

Redefined in descendants as:

- Zend_Db_Statement_Oracle::fetchAll() : fetches an array containing all of the rows from a result set
- Zend_Db_Statement_Db2::fetchAll() : fetches an array containing all of the rows from a result set

fetchColumn (line 181)

returns the data from a single column in a result set

- access: public

void fetchColumn ( $col)

- $col

Implementation of:

Zend_Db_Statement_Interface::fetchColumn()
  returns the data from a single column in a result set

Redefined in descendants as:

- Zend_Db_Statement_Oracle::fetchColumn() : returns the data from a single column in a result set

fetchObject (line 195)

fetches the next row and returns it as an object

- access: public

void fetchObject ([ $class = 'stdClass'], [ $config = null])

- $class
- $config

Implementation of:

Zend_Db_Statement_Interface::fetchObject()
  fetches the next row and returns it as an object

Redefined in descendants as:

- Zend_Db_Statement_Oracle::fetchObject() : fetches the next row and returns it as an object
- Zend_Db_Statement_Db2::fetchObject()

getAttribute (line 209)

retrieves a Zend_Db_Statement attribute

- access: public

void getAttribute ( $key)

- $key

Implementation of:

Zend_Db_Statement_Interface::getAttribute()
  retrieves a Zend_Db_Statement attribute

nextRowset (line 250)

retrieves the next rowset (result set)

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void nextRowset ()

Implementation of:

Zend_Db_Statement_Interface::nextRowset()
  retrieves the next rowset (result set)

Redefined in descendants as:

- Zend_Db_Statement_Db2::nextRowset() : retrieves the next rowset (result set)

rowCount (line 261)

returns the number of rows that were affected by the execution of an SQL statement

- access: public
- todo: needs implementation or better exception message
- todo: fix docblock for params & return types

void rowCount ()

Implementation of:

Zend_Db_Statement_Interface::rowCount()
  returns the number of rows that were affected by the execution of an SQL statement

Redefined in descendants as:

- Zend_Db_Statement_Mysqli::rowCount() : returns the number of rows that were affected by the execution of an SQL statement
- Zend_Db_Statement_Oracle::rowCount() : returns the number of rows that were affected by the execution of an SQL statement
- Zend_Db_Statement_Db2::rowCount()

setAttribute (line 220)

sets a Zend_Db_Statement attribute

- access: public

void setAttribute ( $key, $val)

- $key
- $val

Implementation of:

Zend_Db_Statement_Interface::setAttribute()
  sets a Zend_Db_Statement attribute

setFetchMode (line 229)

sets the fetch mode for a Zend_Db_Statement

- access: public

void setFetchMode ( $mode)

- $mode

Implementation of:

Zend_Db_Statement_Interface::setFetchMode()
  sets the fetch mode for a Zend_Db_Statement

_joinSql (line 110)

Joins SQL text and bound params into a string.

- access: protected

void _joinSql ()
_prepSql (line 84)

Splits SQL into text and params, sets up $this->_bindParam for replacements.

- access: protected

void _prepSql ( $sql)

- $sql

Redefined in descendants as:

- Zend_Db_Statement_Oracle::_prepSql() : Prepares statement handle
- Zend_Db_Statement_Db2::_prepSql() : Prepare statement handle

Documentation generated on Sun, 29 Oct 2006 21:27:32 -0600 by phpDocumentor 1.3.0RC6