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.
Testing Database Statement that acts as a stack to SQL resultsets.

_createRowCountStatement(
int $affectedRows
)
:
\Zend_Test_DbStatement
Create a Row Count Statement

append(
array $row
)
:
void
Append a new row to the fetch stack.
Name | Type | Description |
---|---|---|
$row | array |

bindColumn(
string $column, mixed $param, mixed $type
=
null
)
:
bool
Bind 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
)
:
bool
Binds 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
)
:
bool
Binds 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 |

columnCount(
)
:
int
Returns 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. |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

createDeleteStatement(
int $affectedRows
=
0
)
:
\Zend_Test_DbStatement
Create an Delete Statement

createInsertStatement(
int $affectedRows
=
0
)
:
\Zend_Test_DbStatement
Create an Insert Statement

createSelectStatement(
array $rows
=
array()
)
:
\Zend_Test_DbStatement
Create a Select statement which returns the given array of rows.

createUpdateStatement(
int $affectedRows
=
0
)
:
\Zend_Test_DbStatement
Create an Update Statement

errorCode(
)
:
string
Retrieves the error code, if any, associated with the last operation on the statement handle.
Type | Description |
---|---|
string | error code. |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

errorInfo(
)
:
array
Retrieves an array of error information, if any, associated with the last operation on the statement handle.

execute(
array $params
=
array()
)
:
bool
Executes 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
Fetches a row from the result set.
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
)
:
array
Returns 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
)
:
string
Returns 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 |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

fetchObject(
string $class
=
'stdClass', array $config
=
array()
)
:
mixed
Fetches 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. |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

getAttribute(
string $key
)
:
mixed
Retrieve a statement attribute.
Name | Type | Description |
---|---|---|
$key | string | Attribute name. |
Type | Description |
---|---|
mixed | Attribute value. |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

nextRowset(
)
:
bool
Retrieves 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(
)
:
int
Returns the number of rows affected by the execution of the last INSERT, DELETE, or UPDATE statement executed by this statement object.
Type | Description |
---|---|
int | The number of rows affected. |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

setAttribute(
string $key, mixed $val
)
:
bool
Set 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
)
:
bool
Set the default fetch mode for this statement.
Name | Type | Description |
---|---|---|
$mode | int | The fetch mode. |
Type | Description |
---|---|
bool |
Exception | Description |
---|---|
\Zend_Db_Statement_Exception |

setQueryProfile(
\Zend_Db_Profiler_Query $qp
)
:
void
Name | Type | Description |
---|---|---|
$qp | \Zend_Db_Profiler_Query |