Zend_Db_Statement_Db2 Class Reference

Inheritance diagram for Zend_Db_Statement_Db2:

Public Member Functions
	_prepare ($sql)
	_bindParam ($parameter, &$variable, $type=null, $length=null, $options=null)
	closeCursor ()
	columnCount ()
	errorCode ()
	errorInfo ()
	_execute (array $params=null)
	fetch ($style=null, $cursor=null, $offset=null)
	fetchObject ($class='stdClass', array $config=array())
	nextRowset ()
	rowCount ()
	fetchAll ($style=null, $col=null)
Public Member Functions inherited from Zend_Db_Statement
	__construct ($adapter, $sql)
	bindColumn ($column, &$param, $type=null)
	bindParam ($parameter, &$variable, $type=null, $length=null, $options=null)
	bindValue ($parameter, $value, $type=null)
	execute (array $params=null)
	fetchAll ($style=null, $col=null)
	fetchColumn ($col=0)
	fetchObject ($class='stdClass', array $config=array())
	getAttribute ($key)
	setAttribute ($key, $val)
	setFetchMode ($mode)
	_fetchBound ($row)
	getAdapter ()
	getDriverStatement ()

Protected Attributes
	$_keys
	$_values
Protected Attributes inherited from Zend_Db_Statement
	$_stmt = null
	$_adapter = null
	$_fetchMode = Zend_Db::FETCH_ASSOC
	$_attribute = array()
	$_bindColumn = array()
	$_bindParam = array()
	$_sqlSplit = array()
	$_sqlParam = array()
	$_queryId = null

Additional Inherited Members
Protected Member Functions inherited from Zend_Db_Statement
	_prepare ($sql)
	_parseParameters ($sql)
	_stripQuoted ($sql)

Detailed Description

Definition at line 36 of file Db2.php.

Member Function Documentation

_bindParam()

_bindParam	(		$parameter,
		&	$variable,
			$type = null,
			$length = null,
			$options = null
	)

Binds a parameter to the specified variable name.

Parameters

mixed	$parameter	Name the parameter, either integer or string.
mixed	$variable	Reference to PHP variable containing the value.
mixed	$type	OPTIONAL Datatype of SQL parameter.
mixed	$length	OPTIONAL Length of SQL parameter.
mixed	$options	OPTIONAL Other options.

Returns

bool

Exceptions

Zend_Db_Statement_Db2_Exception

See also

Zend_Db_Statement_Db2_Exception

Definition at line 87 of file Db2.php.

    {
        if ($type === null) {
            $type = DB2_PARAM_IN;
        }

        if (isset($options['data-type'])) {
            $datatype = $options['data-type'];
        } else {
            $datatype = DB2_CHAR;
        }

        if (!db2_bind_param($this->_stmt, $parameter, "variable", $type, $datatype)) {
            #require_once 'Zend/Db/Statement/Db2/Exception.php';
            throw new Zend_Db_Statement_Db2_Exception(
                db2_stmt_errormsg(),
                db2_stmt_error()
            );
        }

        return true;
    }

_execute()

_execute

(

array

$params = null

)

Executes a prepared statement.

Parameters

array

$params

OPTIONAL Values to bind to parameter placeholders.

Returns

bool

Exceptions

Zend_Db_Statement_Db2_Exception

See also

Zend_Db_Statement_Db2_Exception

Definition at line 194 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }

        $retval = true;
        if ($params !== null) {
            $retval = @db2_execute($this->_stmt, $params);
        } else {
            $retval = @db2_execute($this->_stmt);
        }

        if ($retval === false) {
            #require_once 'Zend/Db/Statement/Db2/Exception.php';
            throw new Zend_Db_Statement_Db2_Exception(
                db2_stmt_errormsg(),
                db2_stmt_error());
        }

        $this->_keys = array();
        if ($field_num = $this->columnCount()) {
            for ($i = 0; $i < $field_num; $i++) {
                $name = db2_field_name($this->_stmt, $i);
                $this->_keys[] = $name;
            }
        }

        $this->_values = array();
        if ($this->_keys) {
            $this->_values = array_fill(0, count($this->_keys), null);
        }

        return $retval;
    }

_prepare()

_prepare

(

$sql

)

Prepare a statement handle.

Parameters

string

$sql

Returns

void

Exceptions

Zend_Db_Statement_Db2_Exception

See also

Zend_Db_Statement_Db2_Exception

Definition at line 56 of file Db2.php.

    {
        $connection = $this->_adapter->getConnection();

        // db2_prepare on i5 emits errors, these need to be
        // suppressed so that proper exceptions can be thrown
        $this->_stmt = @db2_prepare($connection, $sql);

        if (!$this->_stmt) {
            #require_once 'Zend/Db/Statement/Db2/Exception.php';
            throw new Zend_Db_Statement_Db2_Exception(
                db2_stmt_errormsg(),
                db2_stmt_error()
            );
        }
    }

closeCursor()

closeCursor

(

)

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

Returns

bool

Implements Zend_Db_Statement_Interface.

Definition at line 118 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }
        db2_free_stmt($this->_stmt);
        $this->_stmt = false;
        return true;
    }

columnCount()

columnCount

(

)

Returns the number of columns in the result set. Returns null if the statement has no result set metadata.

Returns

int The number of columns.

Implements Zend_Db_Statement_Interface.

Definition at line 135 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }
        return db2_num_fields($this->_stmt);
    }

errorCode()

errorCode

(

)

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

Returns

string error code.

Implements Zend_Db_Statement_Interface.

Definition at line 149 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }

        $error = db2_stmt_error();
        if ($error === '') {
            return false;
        }

        return $error;
    }

errorInfo()

errorInfo

(

)

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

Returns

array

Implements Zend_Db_Statement_Interface.

Definition at line 169 of file Db2.php.

    {
        $error = $this->errorCode();
        if ($error === false){
            return false;
        }

        /*
         * Return three-valued array like PDO.  But DB2 does not distinguish
         * between SQLCODE and native RDBMS error code, so repeat the SQLCODE.
         */
        return array(
            $error,
            $error,
            db2_stmt_errormsg()
        );
    }

fetch()

fetch	(		$style = null,
			$cursor = null,
			$offset = null
	)

Fetches a row from the result set.

Parameters

int	$style	OPTIONAL Fetch mode for this fetch operation.
int	$cursor	OPTIONAL Absolute, relative, or other.
int	$offset	OPTIONAL Number for absolute or relative cursors.

Returns

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

Exceptions

Zend_Db_Statement_Db2_Exception

See also

Zend_Db_Statement_Db2_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 242 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }

        if ($style === null) {
            $style = $this->_fetchMode;
        }

        switch ($style) {
            case Zend_Db::FETCH_NUM :
                $row = db2_fetch_array($this->_stmt);
                break;
            case Zend_Db::FETCH_ASSOC :
                $row = db2_fetch_assoc($this->_stmt);
                break;
            case Zend_Db::FETCH_BOTH :
                $row = db2_fetch_both($this->_stmt);
                break;
            case Zend_Db::FETCH_OBJ :
                $row = db2_fetch_object($this->_stmt);
                break;
            case Zend_Db::FETCH_BOUND:
                $row = db2_fetch_both($this->_stmt);
                if ($row !== false) {
                    return $this->_fetchBound($row);
                }
                break;
            default:
                #require_once 'Zend/Db/Statement/Db2/Exception.php';
                throw new Zend_Db_Statement_Db2_Exception("Invalid fetch mode '$style' specified");
                break;
        }

        return $row;
    }

fetchAll()

fetchAll	(		$style = null,
			$col = null
	)

Returns an array containing all of the result set rows.

Parameters

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

Returns

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'

Implements Zend_Db_Statement_Interface.

Definition at line 346 of file Db2.php.

    {
        $data = parent::fetchAll($style, $col);
        $results = array();
        $remove = $this->_adapter->foldCase('ZEND_DB_ROWNUM');

        foreach ($data as $row) {
            if (is_array($row) && array_key_exists($remove, $row)) {
                unset($row[$remove]);
            }
            $results[] = $row;
        }
        return $results;
    }

fetchObject()

fetchObject	(		$class = 'stdClass',
		array	$config = array()
	)

Fetches the next row and returns it as an object.

Parameters

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

Returns

mixed One object instance of the specified class.

Implements Zend_Db_Statement_Interface.

Definition at line 290 of file Db2.php.

    {
        $obj = $this->fetch(Zend_Db::FETCH_OBJ);
        return $obj;
    }

nextRowset()

nextRowset

(

)

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

bool

Exceptions

Zend_Db_Statement_Db2_Exception

See also

Zend_Db_Statement_Db2_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 304 of file Db2.php.

    {
        #require_once 'Zend/Db/Statement/Db2/Exception.php';
        throw new Zend_Db_Statement_Db2_Exception(__FUNCTION__ . '() is not implemented');
    }

rowCount()

rowCount

(

)

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

Returns

int The number of rows affected.

Implements Zend_Db_Statement_Interface.

Definition at line 320 of file Db2.php.

    {
        if (!$this->_stmt) {
            return false;
        }

        $num = @db2_num_rows($this->_stmt);

        if ($num === false) {
            return 0;
        }

        return $num;
    }

Field Documentation

$_keys

$_keys

protected

Column names.

Definition at line 42 of file Db2.php.

$_values

$_values

protected

Fetched result values.

Definition at line 47 of file Db2.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Db/Statement/Db2.php