Db/Statement.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Db
- Subpackage
- Statement
- Version
- $Id: Statement.php 24790 2012-05-10 12:28:51Z [email protected] $
\Zend_Db_Statement
Abstract class to emulate a PDOStatement for native database adapters.
- Implements
- \Zend_Db_Statement_Interface
- Children
- \Zend_Db_Statement_Oracle
- \Zend_Db_Statement_Mysqli
- \Zend_Db_Statement_Pdo
- \Zend_Db_Statement_Sqlsrv
- \Zend_Db_Statement_Db2
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_attribute = array()Attributes.
array()Details- Type
- array
array $_bindColumn = array()Column result bindings.
array()Details- Type
- array
array $_bindParam = array()Query parameter bindings; covers bindParam() and bindValue().
array()Details- Type
- array
integer $_fetchMode = \Zend_Db::FETCH_ASSOCThe current fetch mode.
\Zend_Db::FETCH_ASSOCDetails- Type
- integer
array $_sqlParam = array()Parameter placeholders in the SQL string by position in the split array.
array()Details- Type
- array
array $_sqlSplit = array()SQL string split into an array at placeholders.
array()Details- Type
- array
resource|object $_stmt = nullnullDetails- Type
- resource | object
Methods
__construct(\Zend_Db_Adapter_Abstract $adapter, mixed $sql) : voidConstructor for a statement.
| Name | Type | Description |
|---|---|---|
| $adapter | \Zend_Db_Adapter_Abstract | |
| $sql | mixed | Either a string or Zend_Db_Select. |
_fetchBound(array $row) : boolHelper function to map retrieved row to bound column variables
| Name | Type | Description |
|---|---|---|
| $row | array |
| Type | Description |
|---|---|
| bool | True |
_parseParameters(string $sql) : void| Name | Type | Description |
|---|---|---|
| $sql | string |
_prepare( $sql) : voidInternal method called by abstract statment constructor to setup the driver level statement
| Name | Type | Description |
|---|---|---|
| $sql |
_stripQuoted(string $sql) : stringRemove parts of a SQL string that contain quoted strings of values or identifiers.
| Name | Type | Description |
|---|---|---|
| $sql | string |
| Type | Description |
|---|---|
| string |
bindColumn(string $column, mixed $param, mixed $type = null) : boolBind a column of the statement result set to a PHP variable.
| Name | Type | Description |
|---|---|---|
| $column | string | Name the column in the result set, either by position or by name. |
| $param | mixed | Reference to the PHP variable containing the value. |
| $type | mixed | OPTIONAL |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
bindParam(mixed $parameter, mixed $variable, mixed $type = null, mixed $length = null, mixed $options = null) : boolBinds a parameter to the specified variable name.
| Name | Type | Description |
|---|---|---|
| $parameter | mixed | Name the parameter, either integer or string. |
| $variable | mixed | Reference to PHP variable containing the value. |
| $type | mixed | OPTIONAL Datatype of SQL parameter. |
| $length | mixed | OPTIONAL Length of SQL parameter. |
| $options | mixed | OPTIONAL Other options. |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
bindValue(mixed $parameter, mixed $value, mixed $type = null) : boolBinds a value to a parameter.
| Name | Type | Description |
|---|---|---|
| $parameter | mixed | Name the parameter, either integer or string. |
| $value | mixed | Scalar value to bind to the parameter. |
| $type | mixed | OPTIONAL Datatype of the parameter. |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
closeCursor() : boolCloses the cursor, allowing the statement to be executed again.
Inherited from: \Zend_Db_Statement_Interface::closeCursor()| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
columnCount() : intReturns the number of columns in the result set.
Inherited from: \Zend_Db_Statement_Interface::columnCount()Returns null if the statement has no result set metadata.
| Type | Description |
|---|---|
| int | The number of columns. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
errorCode() : stringRetrieves the error code, if any, associated with the last operation on the statement handle.
Inherited from: \Zend_Db_Statement_Interface::errorCode()| Type | Description |
|---|---|
| string | error code. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
errorInfo() : arrayRetrieves an array of error information, if any, associated with the last operation on the statement handle.
Inherited from: \Zend_Db_Statement_Interface::errorInfo()| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
execute(array $params = null) : boolExecutes a prepared statement.
| Name | Type | Description |
|---|---|---|
| $params | array | OPTIONAL Values to bind to parameter placeholders. |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
fetch(int $style = null, int $cursor = null, int $offset = null) : mixed
| Name | Type | Description |
|---|---|---|
| $style | int | OPTIONAL Fetch mode for this fetch operation. |
| $cursor | int | OPTIONAL Absolute, relative, or other. |
| $offset | int | OPTIONAL Number for absolute or relative cursors. |
| Type | Description |
|---|---|
| mixed | Array, object, or scalar depending on fetch mode. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
fetchAll(int $style = null, int $col = null) : arrayReturns an array containing all of the result set rows.
| Name | Type | Description |
|---|---|---|
| $style | int | OPTIONAL Fetch mode. |
| $col | int | OPTIONAL Column number, if fetch mode is by column. |
| Type | Description |
|---|---|
| array | Collection of rows, each in a format by the fetch mode. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
fetchColumn(int $col = 0) : stringReturns a single column from the next row of a result set.
| Name | Type | Description |
|---|---|---|
| $col | int | OPTIONAL Position of the column to fetch. |
| Type | Description |
|---|---|
| string | One value from the next row of result set, or false. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
fetchObject(string $class = 'stdClass', array $config = array()) : mixedFetches the next row and returns it as an object.
| Name | Type | Description |
|---|---|---|
| $class | string | OPTIONAL Name of the class to create. |
| $config | array | OPTIONAL Constructor arguments for the class. |
| Type | Description |
|---|---|
| mixed | One object instance of the specified class, or false. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
getAdapter() : \Zend_Db_Adapter_AbstractGets the Zend_Db_Adapter_Abstract for this particular Zend_Db_Statement object.
| Type | Description |
|---|---|
| \Zend_Db_Adapter_Abstract |
getAttribute(string $key) : mixedRetrieve a statement attribute.
| Name | Type | Description |
|---|---|---|
| $key | string | Attribute name. |
| Type | Description |
|---|---|
| mixed | Attribute value. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
getDriverStatement() : \unknown_typeGets the resource or object setup by the _parse
| Type | Description |
|---|---|
| \unknown_type |
nextRowset() : boolRetrieves the next rowset (result set) for a SQL statement that has multiple result sets.
Inherited from: \Zend_Db_Statement_Interface::nextRowset()An example is a stored procedure that returns the results of multiple queries.
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
rowCount() : intReturns the number of rows affected by the execution of the last INSERT, DELETE, or UPDATE statement executed by this statement object.
Inherited from: \Zend_Db_Statement_Interface::rowCount()| Type | Description |
|---|---|
| int | The number of rows affected. |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
setAttribute(string $key, mixed $val) : boolSet a statement attribute.
| Name | Type | Description |
|---|---|---|
| $key | string | Attribute name. |
| $val | mixed | Attribute value. |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |
setFetchMode(int $mode) : boolSet the default fetch mode for this statement.
| Name | Type | Description |
|---|---|---|
| $mode | int | The fetch mode. |
| Type | Description |
|---|---|
| bool |
| Exception | Description |
|---|---|
| \Zend_Db_Statement_Exception |