API Documentation

Zend/Db/Statement/Db2.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Db  
Subpackage
Statement  
Version
$Id: Db2.php 24626 2012-02-22 21:58:54Z adamlundrigan $  

\Zend_Db_Statement_Db2

Package: Zend\Db\Statement

Extends for DB2 native adapter.

Parent(s)
\Zend_Db_Statement
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_keys= ''

Column names.

Details
Type
Propertyprotected  $_values= ''

Fetched result values.

Details
Type

Methods

methodpublic_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
Type Description
bool
Throws
Exception Description
\Zend_Db_Statement_Db2_Exception
methodpublic_execute( array $params = null ) : bool

Executes a prepared statement.

Parameters
Name Type Description
$params array

OPTIONAL Values to bind to parameter placeholders.

Returns
Type Description
bool
Throws
Exception Description
\Zend_Db_Statement_Db2_Exception
methodpublic_prepare( string $sql ) : void

Prepare a statement handle.

Parameters
Name Type Description
$sql string
Throws
Exception Description
\Zend_Db_Statement_Db2_Exception
methodpubliccloseCursor( ) : bool

Closes the cursor, allowing the statement to be executed again.

Returns
Type Description
bool
methodpubliccolumnCount( ) : 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.
methodpublicerrorCode( ) : string

Retrieves the error code, if any, associated with the last operation on the statement handle.

Returns
Type Description
string error code.
methodpublicerrorInfo( ) : array

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

Returns
Type Description
array
methodpublicfetch( 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
Exception Description
\Zend_Db_Statement_Db2_Exception
methodpublicfetchAll( 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. Behaves like parent, but if limit() is used, the final result removes the extra column 'zend_db_rownum'
methodpublicfetchObject( 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.
methodpublicnextRowset( ) : 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.

Returns
Type Description
bool
Throws
Exception Description
\Zend_Db_Statement_Db2_Exception
methodpublicrowCount( ) : 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.
Documentation was generated by DocBlox 0.15.1.