Zend_Db_Statement Class Reference

Inheritance diagram for Zend_Db_Statement:

Public Member Functions
	__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 ()
Public Member Functions inherited from Zend_Db_Statement_Interface
	closeCursor ()
	columnCount ()
	errorCode ()
	errorInfo ()
	fetch ($style=null, $cursor=null, $offset=null)
	nextRowset ()
	rowCount ()

Protected Member Functions
	_prepare ($sql)
	_parseParameters ($sql)
	_stripQuoted ($sql)

Protected Attributes
	$_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 42 of file Statement.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$adapter,
			$sql
	)

Constructor for a statement.

Parameters

Zend_Db_Adapter_Abstract	$adapter
mixed	$sql	Either a string or Zend_Db_Select.

Definition at line 108 of file Statement.php.

    {
        $this->_adapter = $adapter;
        if ($sql instanceof Zend_Db_Select) {
            $sql = $sql->assemble();
        }
        $this->_parseParameters($sql);
        $this->_prepare($sql);

        $this->_queryId = $this->_adapter->getProfiler()->queryStart($sql);
    }

Member Function Documentation

_fetchBound()

_fetchBound

(

$row

)

Helper function to map retrieved row to bound column variables

Parameters

array

$row

Returns

bool True

Definition at line 452 of file Statement.php.

    {
        foreach ($row as $key => $value) {
            // bindColumn() takes 1-based integer positions
            // but fetch() returns 0-based integer indexes
            if (is_int($key)) {
                $key++;
            }
            // set results only to variables that were bound previously
            if (isset($this->_bindColumn[$key])) {
                $this->_bindColumn[$key] = $value;
            }
        }
        return true;
    }

_parseParameters()

_parseParameters (   $sql )

protected

Parameters

string

$sql

Returns

void

See also

Zend_Db_Statement_Exception

Zend_Db_Statement_Exception

Definition at line 135 of file Statement.php.

    {
        $sql = $this->_stripQuoted($sql);

        // split into text and params
        $this->_sqlSplit = preg_split('/(\?|\:[a-zA-Z0-9_]+)/',
            $sql, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY);

        // map params
        $this->_sqlParam = array();
        foreach ($this->_sqlSplit as $key => $val) {
            if ($val == '?') {
                if ($this->_adapter->supportsParameters('positional') === false) {
                    #require_once 'Zend/Db/Statement/Exception.php';
                    throw new Zend_Db_Statement_Exception("Invalid bind-variable position '$val'");
                }
            } else if ($val[0] == ':') {
                if ($this->_adapter->supportsParameters('named') === false) {
                    #require_once 'Zend/Db/Statement/Exception.php';
                    throw new Zend_Db_Statement_Exception("Invalid bind-variable name '$val'");
                }
            }
            $this->_sqlParam[] = $val;
        }

        // set up for binding
        $this->_bindParam = array();
    }

_prepare()

_prepare (   $sql )

protected

Internal method called by abstract statment constructor to setup the driver level statement

Returns

void

Definition at line 126 of file Statement.php.

    {
        return;
    }

_stripQuoted()

_stripQuoted (   $sql )

protected

Remove parts of a SQL string that contain quoted strings of values or identifiers.

Parameters

string

$sql

Returns

string

Definition at line 177 of file Statement.php.

    {

        // get the character for value quoting
        // this should be '
        $q = $this->_adapter->quote('a');
        $q = $q[0];
        // get the value used as an escaped quote,
        // e.g. \' or ''
        $qe = $this->_adapter->quote($q);
        $qe = substr($qe, 1, 2);
        $qe = preg_quote($qe);
        $escapeChar = substr($qe,0,1);
        // remove 'foo\'bar'
        if (!empty($q)) {
            $escapeChar = preg_quote($escapeChar);
            // this segfaults only after 65,000 characters instead of 9,000
            $sql = preg_replace("/$q([^$q{$escapeChar}]*|($qe)*)*$q/s", '', $sql);
        }

        // get a version of the SQL statement with all quoted
        // values and delimited identifiers stripped out
        // remove "foo\"bar"
        $sql = preg_replace("/\"(\\\\\"|[^\"])*\"/Us", '', $sql);

        // get the character for delimited id quotes,
        // this is usually " but in MySQL is `
        $d = $this->_adapter->quoteIdentifier('a');
        $d = $d[0];
        // get the value used as an escaped delimited id quote,
        // e.g. \" or "" or \`
        $de = $this->_adapter->quoteIdentifier($d);
        $de = substr($de, 1, 2);
        $de = preg_quote($de);
        // Note: $de and $d where never used..., now they are:
        $sql = preg_replace("/$d($de|\\\\{2}|[^$d])*$d/Us", '', $sql);
        return $sql;
    }

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

Implements Zend_Db_Statement_Interface.

Definition at line 225 of file Statement.php.

    {
        $this->_bindColumn[$column] =& $param;
        return true;
    }

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

See also

Zend_Db_Statement_Exception

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 241 of file Statement.php.

    {
        if (!is_int($parameter) && !is_string($parameter)) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception('Invalid bind-variable position');
        }

        $position = null;
        if (($intval = (int) $parameter) > 0 && $this->_adapter->supportsParameters('positional')) {
            if ($intval >= 1 || $intval <= count($this->_sqlParam)) {
                $position = $intval;
            }
        } else if ($this->_adapter->supportsParameters('named')) {
            if ($parameter[0] != ':') {
                $parameter = ':' . $parameter;
            }
            if (in_array($parameter, $this->_sqlParam) !== false) {
                $position = $parameter;
            }
        }

        if ($position === null) {
            #require_once 'Zend/Db/Statement/Exception.php';
            throw new Zend_Db_Statement_Exception("Invalid bind-variable position '$parameter'");
        }

        // Finally we are assured that $position is valid
        $this->_bindParam[$position] =& $variable;
        return $this->_bindParam($position, $variable, $type, $length, $options);
    }

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

Implements Zend_Db_Statement_Interface.

Definition at line 286 of file Statement.php.

    {
        return $this->bindParam($parameter, $value, $type);
    }

execute()

execute

(

array

$params = null

)

Executes a prepared statement.

Parameters

array

$params

OPTIONAL Values to bind to parameter placeholders.

Returns

bool

Implements Zend_Db_Statement_Interface.

Definition at line 297 of file Statement.php.

    {
        /*
         * Simple case - no query profiler to manage.
         */
        if ($this->_queryId === null) {
            return $this->_execute($params);
        }

        /*
         * Do the same thing, but with query profiler
         * management before and after the execute.
         */
        $prof = $this->_adapter->getProfiler();
        $qp = $prof->getQueryProfile($this->_queryId);
        if ($qp->hasEnded()) {
            $this->_queryId = $prof->queryClone($qp);
            $qp = $prof->getQueryProfile($this->_queryId);
        }
        if ($params !== null) {
            $qp->bindParams($params);
        } else {
            $qp->bindParams($this->_bindParam);
        }
        $qp->start($this->_queryId);

        $retval = $this->_execute($params);

        $prof->queryEnd($this->_queryId);

        return $retval;
    }

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.

Implements Zend_Db_Statement_Interface.

Definition at line 337 of file Statement.php.

    {
        $data = array();
        if ($style === Zend_Db::FETCH_COLUMN && $col === null) {
            $col = 0;
        }
        if ($col === null) {
            while ($row = $this->fetch($style)) {
                $data[] = $row;
            }
        } else {
            while (false !== ($val = $this->fetchColumn($col))) {
                $data[] = $val;
            }
        }
        return $data;
    }

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 One value from the next row of result set, or false.

Implements Zend_Db_Statement_Interface.

Definition at line 361 of file Statement.php.

    {
        $data = array();
        $col = (int) $col;
        $row = $this->fetch(Zend_Db::FETCH_NUM);
        if (!is_array($row)) {
            return false;
        }
        return $row[$col];
    }

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, or false.

Implements Zend_Db_Statement_Interface.

Definition at line 379 of file Statement.php.

    {
        $obj = new $class($config);
        $row = $this->fetch(Zend_Db::FETCH_ASSOC);
        if (!is_array($row)) {
            return false;
        }
        foreach ($row as $key => $val) {
            $obj->$key = $val;
        }
        return $obj;
    }

getAdapter()

getAdapter

(

)

Gets the Zend_Db_Adapter_Abstract for this particular Zend_Db_Statement object.

Returns

Zend_Db_Adapter_Abstract

Definition at line 474 of file Statement.php.

    {
        return $this->_adapter;
    }

getAttribute()

getAttribute

(

$key

)

Retrieve a statement attribute.

Parameters

string

$key

Attribute name.

Returns

mixed Attribute value.

Implements Zend_Db_Statement_Interface.

Definition at line 398 of file Statement.php.

    {
        if (array_key_exists($key, $this->_attribute)) {
            return $this->_attribute[$key];
        }
    }

getDriverStatement()

getDriverStatement

(

)

Gets the resource or object setup by the _parse

Returns

unknown_type

Definition at line 484 of file Statement.php.

    {
        return $this->_stmt;
    }

setAttribute()

setAttribute	(		$key,
			$val
	)

Set a statement attribute.

Parameters

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

Returns

bool

Implements Zend_Db_Statement_Interface.

Definition at line 412 of file Statement.php.

    {
        $this->_attribute[$key] = $val;
    }

setFetchMode()

setFetchMode

(

$mode

)

Set the default fetch mode for this statement.

Parameters

int

$mode

The fetch mode.

Returns

bool

Exceptions

Zend_Db_Statement_Exception

See also

Zend_Db_Statement_Exception

Implements Zend_Db_Statement_Interface.

Definition at line 424 of file Statement.php.

    {
        switch ($mode) {
            case Zend_Db::FETCH_NUM:
            case Zend_Db::FETCH_ASSOC:
            case Zend_Db::FETCH_BOTH:
            case Zend_Db::FETCH_OBJ:
                $this->_fetchMode = $mode;
                break;
            case Zend_Db::FETCH_BOUND:
            default:
                $this->closeCursor();
                #require_once 'Zend/Db/Statement/Exception.php';
                throw new Zend_Db_Statement_Exception('invalid fetch mode');
                break;
        }
    }

Field Documentation

$_adapter

$_adapter = null

protected

Definition at line 53 of file Statement.php.

$_attribute

$_attribute = array()

protected

Definition at line 67 of file Statement.php.

$_bindColumn

$_bindColumn = array()

protected

Definition at line 74 of file Statement.php.

$_bindParam

$_bindParam = array()

protected

Definition at line 81 of file Statement.php.

$_fetchMode

$_fetchMode = Zend_Db::FETCH_ASSOC

protected

Definition at line 60 of file Statement.php.

$_queryId

$_queryId = null

protected

Definition at line 100 of file Statement.php.

$_sqlParam

$_sqlParam = array()

protected

Definition at line 95 of file Statement.php.

$_sqlSplit

$_sqlSplit = array()

protected

Definition at line 88 of file Statement.php.

$_stmt

$_stmt = null

protected

Definition at line 48 of file Statement.php.

---

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

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