Zend_Db_Statement_Pdo Class Reference

Inheritance diagram for Zend_Db_Statement_Pdo:

Public Member Functions
	bindColumn ($column, &$param, $type=null)
	bindValue ($parameter, $value, $type=null)
	closeCursor ()
	columnCount ()
	errorCode ()
	errorInfo ()
	_execute (array $params=null)
	fetch ($style=null, $cursor=null, $offset=null)
	getIterator ()
	fetchAll ($style=null, $col=null)
	fetchColumn ($col=0)
	fetchObject ($class='stdClass', array $config=array())
	getAttribute ($key)
	getColumnMeta ($column)
	nextRowset ()
	rowCount ()
	setAttribute ($key, $val)
	setFetchMode ($mode)
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 Member Functions
	_prepare ($sql)
	_bindParam ($parameter, &$variable, $type=null, $length=null, $options=null)
Protected Member Functions inherited from Zend_Db_Statement
	_prepare ($sql)
	_parseParameters ($sql)
	_stripQuoted ($sql)

Protected Attributes
	$_fetchMode = PDO::FETCH_ASSOC
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

Detailed Description

Definition at line 40 of file Pdo.php.

Member Function Documentation

_bindParam()

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

protected

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_Exception

Definition at line 100 of file Pdo.php.

    {
        try {
            if ($type === null) {
                if (is_bool($variable)) {
                    $type = PDO::PARAM_BOOL;
                } elseif ($variable === null) {
                    $type = PDO::PARAM_NULL;
                } elseif (is_integer($variable)) {
                    $type = PDO::PARAM_INT;
                } else {
                    $type = PDO::PARAM_STR;
                }
            }
            return $this->_stmt->bindParam($parameter, $variable, $type, $length, $options);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

_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_Exception

Definition at line 224 of file Pdo.php.

    {
        try {
            if ($params !== null) {
                return $this->_stmt->execute($params);
            } else {
                return $this->_stmt->execute();
            }
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            $message = sprintf('%s, query was: %s', $e->getMessage(), $this->_stmt->queryString);
            throw new Zend_Db_Statement_Exception($message, (int) $e->getCode(), $e);
        }
    }

_prepare()

_prepare (   $sql )

protected

Prepare a string SQL statement and create a statement object.

Parameters

string

$sql

Returns

void

Exceptions

Zend_Db_Statement_Exception

Definition at line 55 of file Pdo.php.

    {
        try {
            $this->_stmt = $this->_adapter->getConnection()->prepare($sql);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

bindColumn()

bindColumn	(		$column,
		&	$param,
			$type = null
	)

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

Parameters

string	$column	Name the column in the result set, either by position or by name.
mixed	$param	Reference to the PHP variable containing the value.
mixed	$type	OPTIONAL

Returns

bool

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 75 of file Pdo.php.

    {
        try {
            if ($type === null) {
                return $this->_stmt->bindColumn($column, $param);
            } else {
                return $this->_stmt->bindColumn($column, $param, $type);
            }
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

bindValue()

bindValue	(		$parameter,
			$value,
			$type = null
	)

Binds a value to a parameter.

Parameters

mixed	$parameter	Name the parameter, either integer or string.
mixed	$value	Scalar value to bind to the parameter.
mixed	$type	OPTIONAL Datatype of the parameter.

Returns

bool

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 130 of file Pdo.php.

    {
        if (is_string($parameter) && $parameter[0] != ':') {
            $parameter = ":$parameter";
        }

        $this->_bindParam[$parameter] = $value;

        try {
            if ($type === null) {
                return $this->_stmt->bindValue($parameter, $value);
            } else {
                return $this->_stmt->bindValue($parameter, $value, $type);
            }
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

closeCursor()

closeCursor

(

)

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

Returns

bool

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 156 of file Pdo.php.

    {
        try {
            return $this->_stmt->closeCursor();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

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.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 173 of file Pdo.php.

    {
        try {
            return $this->_stmt->columnCount();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

errorCode()

errorCode

(

)

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

Returns

string error code.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 190 of file Pdo.php.

    {
        try {
            return $this->_stmt->errorCode();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

errorInfo()

errorInfo

(

)

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

Returns

array

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 207 of file Pdo.php.

    {
        try {
            return $this->_stmt->errorInfo();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

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_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 248 of file Pdo.php.

    {
        if ($style === null) {
            $style = $this->_fetchMode;
        }
        try {
            return $this->_stmt->fetch($style, $cursor, $offset);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

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.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 279 of file Pdo.php.

    {
        if ($style === null) {
            $style = $this->_fetchMode;
        }
        try {
            if ($style == PDO::FETCH_COLUMN) {
                if ($col === null) {
                    $col = 0;
                }
                return $this->_stmt->fetchAll($style, $col);
            } else {
                return $this->_stmt->fetchAll($style);
            }
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

fetchColumn()

fetchColumn

(

$col = 0

)

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

Parameters

int

$col

OPTIONAL Position of the column to fetch.

Returns

string

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 306 of file Pdo.php.

    {
        try {
            return $this->_stmt->fetchColumn($col);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

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.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 324 of file Pdo.php.

    {
        try {
            return $this->_stmt->fetchObject($class, $config);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

getAttribute()

getAttribute

(

$key

)

Retrieve a statement attribute.

Parameters

integer

$key

Attribute name.

Returns

mixed Attribute value.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 341 of file Pdo.php.

    {
        try {
            return $this->_stmt->getAttribute($key);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

getColumnMeta()

getColumnMeta

(

$column

)

Returns metadata for a column in a result set.

Parameters

int

$column

Returns

mixed

Exceptions

Zend_Db_Statement_Exception

Definition at line 358 of file Pdo.php.

    {
        try {
            return $this->_stmt->getColumnMeta($column);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

getIterator()

getIterator

(

)

Required by IteratorAggregate interface

Returns

IteratorIterator

Definition at line 266 of file Pdo.php.

    {
        return new IteratorIterator($this->_stmt);
    }

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_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 376 of file Pdo.php.

    {
        try {
            return $this->_stmt->nextRowset();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

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.

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 394 of file Pdo.php.

    {
        try {
            return $this->_stmt->rowCount();
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

setAttribute()

setAttribute	(		$key,
			$val
	)

Set a statement attribute.

Parameters

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

Returns

bool

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 412 of file Pdo.php.

    {
        try {
            return $this->_stmt->setAttribute($key, $val);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

setFetchMode()

setFetchMode

(

$mode

)

Set the default fetch mode for this statement.

Parameters

int

$mode

The fetch mode.

Returns

bool

Exceptions

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 429 of file Pdo.php.

    {
        $this->_fetchMode = $mode;
        try {
            return $this->_stmt->setFetchMode($mode);
        } catch (PDOException $e) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception($e->getMessage(), $e->getCode(), $e);
        }
    }

Field Documentation

$_fetchMode

$_fetchMode = PDO::FETCH_ASSOC

protected

Definition at line 46 of file Pdo.php.

---

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

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