Db/Statement.php
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 license@zend.com so we can send you a copy immediately.
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Db
- subpackage
- Statement
- version
- $Id: Statement.php 23775 2011-03-01 17:25:24Z ralph $
Abstract class to emulate a PDOStatement for native database adapters.
- Implements
- \Zend_Db_Statement_Interface
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- license
-
New BSD License
- package
- Zend_Db
- subpackage
- Statement
Properties



array
$_bindParam= 'array'
Query parameter bindings; covers bindParam() and bindValue().
Default valuearray
Details
- Type
- array



array
$_sqlParam= 'array'
Parameter placeholders in the SQL string by position in the split array.
Default valuearray
Details
- Type
- array



array
$_sqlSplit= 'array'
SQL string split into an array at placeholders.
Default valuearray
Details
- Type
- array



resource|object
$_stmt= 'null'
The driver level statement object/resource
Default valuenull
Details
- Type
- resourceobject
Methods



_fetchBound(
array $row
)
:
bool
Helper function to map retrieved row
to bound column variables
Parameters
Name |
Type |
Description |
$row |
array |
|
Returns
Type |
Description |
bool |
True |



_prepare(
$sql
)
:
void
Internal method called by abstract statment constructor to setup
the driver level statement
Parameters
Name |
Type |
Description |
$sql |
|
|



_stripQuoted(
string $sql
)
:
string
Remove parts of a SQL string that contain quoted strings
of values or identifiers.
Parameters
Name |
Type |
Description |
$sql |
string |
|
Returns



bindColumn(
string $column, mixed $param, mixed $type
=
null
)
:
bool
Bind a column of the statement result set to a PHP variable.
Parameters
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 |
Returns
Throws



bindParam(
mixed $parameter, mixed $variable, mixed $type
=
null, mixed $length
=
null, mixed $options
=
null
)
:
bool
Binds a parameter to the specified variable name.
Parameters
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. |
Returns
Throws



bindValue(
mixed $parameter, mixed $value, mixed $type
=
null
)
:
bool
Binds a value to a parameter.
Parameters
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. |
Returns
Throws



execute(
array $params
=
null
)
:
bool
Executes a prepared statement.
Parameters
Name |
Type |
Description |
$params |
array |
OPTIONAL Values to bind to parameter placeholders. |
Returns
Throws



fetchAll(
int $style
=
null, int $col
=
null
)
:
array
Returns an array containing all of the result set rows.
Parameters
Name |
Type |
Description |
$style |
int |
OPTIONAL Fetch mode. |
$col |
int |
OPTIONAL Column number, if fetch mode is by column. |
Returns
Type |
Description |
array |
Collection of rows, each in a format by the fetch mode. |
Throws



fetchColumn(
int $col
=
0
)
:
string
Returns a single column from the next row of a result set.
Parameters
Name |
Type |
Description |
$col |
int |
OPTIONAL Position of the column to fetch. |
Returns
Type |
Description |
string |
One value from the next row of result set, or false. |
Throws



fetchObject(
string $class
=
stdClass, array $config
=
array
)
:
mixed
Fetches the next row and returns it as an object.
Parameters
Name |
Type |
Description |
$class |
string |
OPTIONAL Name of the class to create. |
$config |
array |
OPTIONAL Constructor arguments for the class. |
Returns
Type |
Description |
mixed |
One object instance of the specified class, or false. |
Throws



getAttribute(
string $key
)
:
mixed
Retrieve a statement attribute.
Parameters
Name |
Type |
Description |
$key |
string |
Attribute name. |
Returns
Type |
Description |
mixed |
Attribute value. |
Throws



getDriverStatement(
)
:
\unknown_type
Gets the resource or object setup by the
_parse
Returns
Type |
Description |
\unknown_type |
|



setAttribute(
string $key, mixed $val
)
:
bool
Set a statement attribute.
Parameters
Name |
Type |
Description |
$key |
string |
Attribute name. |
$val |
mixed |
Attribute value. |
Returns
Throws



setFetchMode(
int $mode
)
:
bool
Set the default fetch mode for this statement.
Parameters
Name |
Type |
Description |
$mode |
int |
The fetch mode. |
Returns
Throws