Test/DbStatement.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 [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_Test
- Subpackage
- PHPUnit
- Version
- $Id: DbStatement.php 25024 2012-07-30 15:08:15Z rob $
Package: Zend\Test\PHPUnitTesting Database Statement that acts as a stack to SQL resultsets.
- Implements
- \Zend_Db_Statement_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
-
New BSD License
Properties
Methods
_createRowCountStatement(int $affectedRows) : \Zend_Test_DbStatement
staticCreate a Row Count Statement
Parameters
| Name |
Type |
Description |
| $affectedRows |
int |
|
Returns
append(array $row) : voidAppend a new row to the fetch stack.
Parameters
| Name |
Type |
Description |
| $row |
array |
|
bindColumn(string $column, mixed $param, mixed $type = null) : boolBind 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) : boolBinds 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) : boolBinds 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() : intReturns the number of columns in the result set.
Returns null if the statement has no result set metadata.
| Type |
Description |
| int |
The number of columns. |
Throws
createDeleteStatement(int $affectedRows = 0) : \Zend_Test_DbStatement
staticCreate an Delete Statement
Parameters
| Name |
Type |
Description |
| $affectedRows |
int |
|
Returns
createInsertStatement(int $affectedRows = 0) : \Zend_Test_DbStatement
staticCreate an Insert Statement
Parameters
| Name |
Type |
Description |
| $affectedRows |
int |
|
Returns
createSelectStatement(array $rows = array()) : \Zend_Test_DbStatement
staticCreate a Select statement which returns the given array of rows.
Parameters
| Name |
Type |
Description |
| $rows |
array |
|
Returns
createUpdateStatement(int $affectedRows = 0) : \Zend_Test_DbStatement
staticCreate an Update Statement
Parameters
| Name |
Type |
Description |
| $affectedRows |
int |
|
Returns
errorCode() : stringRetrieves the error code, if any, associated with the last operation on
the statement handle.
Returns
| Type |
Description |
| string |
error code. |
Throws
execute(array $params = array()) : boolExecutes a prepared statement.
Parameters
| Name |
Type |
Description |
| $params |
array |
OPTIONAL Values to bind to parameter placeholders. |
Returns
Throws
fetch(int $style = null, int $cursor = null, int $offset = null) : mixedFetches 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) : arrayReturns 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) : stringReturns 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()) : mixedFetches 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(string $key) : mixedRetrieve a statement attribute.
Parameters
| Name |
Type |
Description |
| $key |
string |
Attribute name. |
Returns
| Type |
Description |
| mixed |
Attribute value. |
Throws
nextRowset() : boolRetrieves the next rowset (result set) for a SQL statement that has
multiple result sets.
An example is a stored procedure that returns
the results of multiple queries.
rowCount() : intReturns 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) : boolSet a statement attribute.
Parameters
| Name |
Type |
Description |
| $key |
string |
Attribute name. |
| $val |
mixed |
Attribute value. |
Returns
Throws
setFetchMode(int $mode) : boolSet the default fetch mode for this statement.
Parameters
| Name |
Type |
Description |
| $mode |
int |
The fetch mode. |
Returns
Throws
inherited
Classes
