Db/Statement/Pdo.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: Pdo.php 23775 2011-03-01 17:25:24Z ralph $
Proxy class to wrap a PDOStatement object.
Matches the interface of PDOStatement. All methods simply proxy to the
matching method in PDOStatement. PDOExceptions thrown by PDOStatement
are re-thrown as Zend_Db_Statement_Exception.
- Extends from
- \Zend_Db_Statement
- Implements
- 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
Methods



_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



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



_prepare(
string $sql
)
:
void
Prepare a string SQL statement and create a statement object.
Parameters
Name |
Type |
Description |
$sql |
string |
|
Throws



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



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



columnCount(
)
:
int
Returns the number of columns in the result set.
Returns null if the statement has no result set metadata.
Returns
Type |
Description |
int |
The number of columns. |
Throws



errorCode(
)
:
string
Retrieves the error code, if any, associated with the last operation on
the statement handle.
Returns
Type |
Description |
string |
error code. |
Throws



fetch(
int $style
=
null, int $cursor
=
null, int $offset
=
null
)
:
mixed
Fetches a row from the result set.
Parameters
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. |
Returns
Type |
Description |
mixed |
Array, object, or scalar depending on fetch mode. |
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
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. |
Throws



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



getColumnMeta(
int $column
)
:
mixed
Returns metadata for a column in a result set.
Parameters
Name |
Type |
Description |
$column |
int |
|
Returns
Throws



rowCount(
)
:
int
Returns the number of rows affected by the execution of the
last INSERT, DELETE, or UPDATE statement executed by this
statement object.
Returns
Type |
Description |
int |
The number of rows affected. |
Throws



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