Db/Statement/Interface.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Statement
version: $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Db_Statement_Interface

Description

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.

Zend_Db_Statement_Interface
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Db
subpackage: Statement
Methods: bindColumn; bindParam; bindValue; closeCursor; columnCount; errorCode; errorInfo; execute; fetch; fetchAll; fetchColumn; fetchObject; getAttribute; nextRowset; rowCount; setAttribute; setFetchMode

Description

Emulates a PDOStatement for native database adapters.

Methods

bindColumn
jump to class

bindColumn(
          string $column, mixed $param, mixed $type
              =
              null
          )
        
        :
        bool

Bind a column of the statement result set to a PHP variable.

Arguments

$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

Output

bool

Details

visibility: public
final: false
static: false
throws

bindParam
jump to class

bindParam(
          mixed $parameter, mixed $variable, mixed $type
              =
              null, mixed $length
              =
              null, mixed $options
              =
              null
          )
        
        :
        bool

Binds a parameter to the specified variable name.

Arguments

$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.

Output

bool

Details

visibility: public
final: false
static: false
throws

bindValue
jump to class

bindValue(
          mixed $parameter, mixed $value, mixed $type
              =
              null
          )
        
        :
        bool

Binds a value to a parameter.

Arguments

$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.

Output

bool

Details

visibility: public
final: false
static: false
throws

closeCursor
jump to class

closeCursor(
          
          )
        
        :
        bool

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

Output

bool

Details

visibility: public
final: false
static: false
throws

columnCount
jump to class

columnCount(
          
          )
        
        :
        int

Returns the number of columns in the result set.

Returns null if the statement has no result set metadata.

Output

int: The number of columns.

Details

visibility: public
final: false
static: false
throws

errorCode
jump to class

errorCode(
          
          )
        
        :
        string

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

Output

string: error code.

Details

visibility: public
final: false
static: false
throws

errorInfo
jump to class

errorInfo(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false
throws

execute
jump to class

execute(
          array $params
              =
              array
          )
        
        :
        bool

Executes a prepared statement.

Arguments

$params: array
OPTIONAL Values to bind to parameter placeholders.

Output

bool

Details

visibility: public
final: false
static: false
throws

fetch
jump to class

fetch(
          int $style
              =
              null, int $cursor
              =
              null, int $offset
              =
              null
          )
        
        :
        mixed

Fetches a row from the result set.

Arguments

$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.

Output

mixed: Array, object, or scalar depending on fetch mode.

Details

visibility: public
final: false
static: false
throws

fetchAll
jump to class

fetchAll(
          int $style
              =
              null, int $col
              =
              null
          )
        
        :
        array

Returns an array containing all of the result set rows.

Arguments

$style: int
OPTIONAL Fetch mode.
$col: int
OPTIONAL Column number, if fetch mode is by column.

Output

array: Collection of rows, each in a format by the fetch mode.

Details

visibility: public
final: false
static: false
throws

fetchColumn
jump to class

fetchColumn(
          int $col
              =
              0
          )
        
        :
        string

Returns a single column from the next row of a result set.

Arguments

$col: int
OPTIONAL Position of the column to fetch.

Output

string

Details

visibility: public
final: false
static: false
throws

fetchObject
jump to class

fetchObject(
          string $class
              =
              stdClass, array $config
              =
              array
          )
        
        :
        mixed

Fetches the next row and returns it as an object.

Arguments

$class: string
OPTIONAL Name of the class to create.
$config: array
OPTIONAL Constructor arguments for the class.

Output

mixed: One object instance of the specified class.

Details

visibility: public
final: false
static: false
throws

getAttribute
jump to class

getAttribute(
          string $key
          )
        
        :
        mixed

Retrieve a statement attribute.

Arguments

$key: string
Attribute name.

Output

mixed: Attribute value.

Details

visibility: public
final: false
static: false
throws

nextRowset
jump to class

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.

Output

bool

Details

visibility: public
final: false
static: false
throws

rowCount
jump to class

rowCount(
          
          )
        
        :
        int

Returns the number of rows affected by the execution of the last INSERT, DELETE, or UPDATE statement executed by this statement object.

Output

int: The number of rows affected.

Details

visibility: public
final: false
static: false
throws

setAttribute
jump to class

setAttribute(
          string $key, mixed $val
          )
        
        :
        bool

Set a statement attribute.

Arguments

$key: string
Attribute name.
$val: mixed
Attribute value.

Output

bool

Details

visibility: public
final: false
static: false
throws

setFetchMode
jump to class

setFetchMode(
          int $mode
          )
        
        :
        bool

Set the default fetch mode for this statement.

Arguments

$mode: int
The fetch mode.

Output

bool

Details

visibility: public
final: false
static: false
throws

API Documentation

Db/Statement/Interface.php

Description

Zend_Db_Statement_Interfacejump to top

Description

Methods

bindColumnjump to class

Arguments

Output

Details

bindParamjump to class

Arguments

Output

Details

bindValuejump to class

Arguments

Output

Details

closeCursorjump to class

Output

Details

columnCountjump to class

Output

Details

errorCodejump to class

Output

Details

errorInfojump to class

Output

Details

executejump to class

Arguments

Output

Details

fetchjump to class

Arguments

Output

Details

fetchAlljump to class

Arguments

Output

Details

fetchColumnjump to class

Arguments

Output

Details

fetchObjectjump to class

Arguments

Output

Details

getAttributejump to class

Arguments

Output

Details

nextRowsetjump to class

Output

Details

rowCountjump to class

Output

Details

setAttributejump to class

Arguments

Output

Details

setFetchModejump to class

Arguments

Output

Details

Zend_Db_Statement_Interface
jump to top

bindColumn
jump to class

bindParam
jump to class

bindValue
jump to class

closeCursor
jump to class

columnCount
jump to class

errorCode
jump to class

errorInfo
jump to class

execute
jump to class

fetch
jump to class

fetchAll
jump to class

fetchColumn
jump to class

fetchObject
jump to class

getAttribute
jump to class

nextRowset
jump to class

rowCount
jump to class

setAttribute
jump to class

setFetchMode
jump to class