Zend_Db_Statement_Sqlsrv Class Reference

Inheritance diagram for Zend_Db_Statement_Sqlsrv:

Public Member Functions
	closeCursor ()
	columnCount ()
	errorCode ()
	errorInfo ()
	_execute (array $params=null)
	fetch ($style=null, $cursor=null, $offset=null)
	fetchColumn ($col=0)
	fetchObject ($class='stdClass', array $config=array())
	getColumnMeta ($column)
	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 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
	$_originalSQL
	$_keys
	$_executed = false
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 37 of file Sqlsrv.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 87 of file Sqlsrv.php.

    {
        //Sql server doesn't support bind by name
        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_Exception

Definition at line 177 of file Sqlsrv.php.

    {
        $connection = $this->_adapter->getConnection();
        if (!$this->_stmt) {
            return false;
        }

        if ($params !== null) {
            if (!is_array($params)) {
                $params = array($params);
            }
            $error = false;

            // make all params passed by reference
            $params_ = array();
            $temp    = array();
            $i       = 1;
            foreach ($params as $param) {
                $temp[$i]  = $param;
                $params_[] = &$temp[$i];
                $i++;
            }
            $params = $params_;
        }

        $this->_stmt = sqlsrv_query($connection, $this->_originalSQL, $params);

        if (!$this->_stmt) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception(sqlsrv_errors());
        }

        $this->_executed = true;

        return (!$this->_stmt);
    }

_prepare()

_prepare (   $sql )

protected

Prepares statement handle

Parameters

string

$sql

Returns

void

Exceptions

Zend_Db_Statement_Sqlsrv_Exception

Definition at line 62 of file Sqlsrv.php.

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

        $this->_stmt = sqlsrv_prepare($connection, $sql);

        if (!$this->_stmt) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception(sqlsrv_errors());
        }

        $this->_originalSQL = $sql;
    }

closeCursor()

closeCursor

(

)

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

Returns

bool

Implements Zend_Db_Statement_Interface.

Definition at line 98 of file Sqlsrv.php.

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

        sqlsrv_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 115 of file Sqlsrv.php.

    {
        if ($this->_stmt && $this->_executed) {
            return sqlsrv_num_fields($this->_stmt);
        }

        return 0;
    }

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 131 of file Sqlsrv.php.

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

        $error = sqlsrv_errors();
        if (!$error) {
            return false;
        }

        return $error[0]['code'];
    }

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 152 of file Sqlsrv.php.

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

        $error = sqlsrv_errors();
        if (!$error) {
            return false;
        }

        return array(
            $error[0]['code'],
            $error[0]['message'],
        );
    }

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 223 of file Sqlsrv.php.

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

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

        $values = sqlsrv_fetch_array($this->_stmt, SQLSRV_FETCH_ASSOC);

        if (!$values && (null !== $error = sqlsrv_errors())) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception($error);
        }

        if (null === $values) {
            return null;
        }

        if (!$this->_keys) {
            foreach ($values as $key => $value) {
                $this->_keys[] = $this->_adapter->foldCase($key);
            }
        }

        $values = array_values($values);

        $row = false;
        switch ($style) {
            case Zend_Db::FETCH_NUM:
                $row = $values;
                break;
            case Zend_Db::FETCH_ASSOC:
                $row = array_combine($this->_keys, $values);
                break;
            case Zend_Db::FETCH_BOTH:
                $assoc = array_combine($this->_keys, $values);
                $row   = array_merge($values, $assoc);
                break;
            case Zend_Db::FETCH_OBJ:
                $row = (object) array_combine($this->_keys, $values);
                break;
            case Zend_Db::FETCH_BOUND:
                $assoc = array_combine($this->_keys, $values);
                $row   = array_merge($values, $assoc);
                $row   = $this->_fetchBound($row);
                break;
            default:
                #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
                throw new Zend_Db_Statement_Sqlsrv_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 426 of file Sqlsrv.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;
    }

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 288 of file Sqlsrv.php.

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

        if (!sqlsrv_fetch($this->_stmt)) {
            if (null !== $error = sqlsrv_errors()) {
                #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
                throw new Zend_Db_Statement_Sqlsrv_Exception($error);
            }

            // If no error, there is simply no record
            return false;
        }

        $data = sqlsrv_get_field($this->_stmt, $col); //0-based
        if ($data === false) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception(sqlsrv_errors());
        }

        return $data;
    }

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 321 of file Sqlsrv.php.

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

        $obj = sqlsrv_fetch_object($this->_stmt);

        if ($error = sqlsrv_errors()) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception($error);
        }

        /* @todo XXX handle parameters */

        if (null === $obj) {
            return false;
        }

        return $obj;
    }

getColumnMeta()

getColumnMeta

(

$column

)

Returns metadata for a column in a result set.

Parameters

int

$column

Returns

mixed

Exceptions

Zend_Db_Statement_Sqlsrv_Exception

Definition at line 350 of file Sqlsrv.php.

    {
        $fields = sqlsrv_field_metadata($this->_stmt);

        if (!$fields) {
            throw new Zend_Db_Statement_Sqlsrv_Exception('Column metadata can not be fetched');
        }

        if (!isset($fields[$column])) {
            throw new Zend_Db_Statement_Sqlsrv_Exception('Column index does not exist in statement');
        }

        return $fields[$column];
    }

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 373 of file Sqlsrv.php.

    {
        if (sqlsrv_next_result($this->_stmt) === false) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception(sqlsrv_errors());
        }

        // reset column keys
        $this->_keys = null;

        return true;
    }

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 Sqlsrv.php.

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

        if (!$this->_executed) {
            return 0;
        }

        $num_rows = sqlsrv_rows_affected($this->_stmt);

        // Strict check is necessary; 0 is a valid return value
        if ($num_rows === false) {
            #require_once 'Zend/Db/Statement/Sqlsrv/Exception.php';
            throw new Zend_Db_Statement_Sqlsrv_Exception(sqlsrv_errors());
        }

        return $num_rows;
    }

Field Documentation

$_executed

$_executed = false

protected

Query executed

Definition at line 53 of file Sqlsrv.php.

$_keys

$_keys

protected

Column names.

Definition at line 48 of file Sqlsrv.php.

$_originalSQL

$_originalSQL

protected

The connection_stmt object original string.

Definition at line 43 of file Sqlsrv.php.

---

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

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