<?php

/**

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

 *

 * @category   Zend

 * @package    Zend_Db

 * @subpackage Statement

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * Emulates a PDOStatement for native database adapters.

 *

 * @category   Zend

 * @package    Zend_Db

 * @subpackage Statement

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Db_Statement_Interface

{

    /**

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

     *

     * @param string $column Name the column in the result set, either by

     *                       position or by name.

     * @param mixed  $param  Reference to the PHP variable containing the value.

     * @param mixed  $type   OPTIONAL

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function bindColumn($column, &$param, $type = null);

    /**

     * Binds a parameter to the specified variable name.

     *

     * @param mixed $parameter Name the parameter, either integer or string.

     * @param mixed $variable  Reference to PHP variable containing the value.

     * @param mixed $type      OPTIONAL Datatype of SQL parameter.

     * @param mixed $length    OPTIONAL Length of SQL parameter.

     * @param mixed $options   OPTIONAL Other options.

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function bindParam($parameter, &$variable, $type = null, $length = null, $options = null);

    /**

     * Binds a value to a parameter.

     *

     * @param mixed $parameter Name the parameter, either integer or string.

     * @param mixed $value     Scalar value to bind to the parameter.

     * @param mixed $type      OPTIONAL Datatype of the parameter.

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function bindValue($parameter, $value, $type = null);

    /**

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

     *

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function closeCursor();

    /**

     * Returns the number of columns in the result set.

     * Returns null if the statement has no result set metadata.

     *

     * @return int The number of columns.

     * @throws Zend_Db_Statement_Exception

     */

    public function columnCount();

    /**

     * Retrieves the error code, if any, associated with the last operation on

     * the statement handle.

     *

     * @return string error code.

     * @throws Zend_Db_Statement_Exception

     */

    public function errorCode();

    /**

     * Retrieves an array of error information, if any, associated with the

     * last operation on the statement handle.

     *

     * @return array

     * @throws Zend_Db_Statement_Exception

     */

    public function errorInfo();

    /**

     * Executes a prepared statement.

     *

     * @param array $params OPTIONAL Values to bind to parameter placeholders.

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function execute(array $params = array());

    /**

     * Fetches a row from the result set.

     *

     * @param int $style  OPTIONAL Fetch mode for this fetch operation.

     * @param int $cursor OPTIONAL Absolute, relative, or other.

     * @param int $offset OPTIONAL Number for absolute or relative cursors.

     * @return mixed Array, object, or scalar depending on fetch mode.

     * @throws Zend_Db_Statement_Exception

     */

    public function fetch($style = null, $cursor = null, $offset = null);

    /**

     * Returns an array containing all of the result set rows.

     *

     * @param int $style OPTIONAL Fetch mode.

     * @param int $col   OPTIONAL Column number, if fetch mode is by column.

     * @return array Collection of rows, each in a format by the fetch mode.

     * @throws Zend_Db_Statement_Exception

     */

    public function fetchAll($style = null, $col = null);

    /**

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

     *

     * @param int $col OPTIONAL Position of the column to fetch.

     * @return string

     * @throws Zend_Db_Statement_Exception

     */

    public function fetchColumn($col = 0);

    /**

     * Fetches the next row and returns it as an object.

     *

     * @param string $class  OPTIONAL Name of the class to create.

     * @param array  $config OPTIONAL Constructor arguments for the class.

     * @return mixed One object instance of the specified class.

     * @throws Zend_Db_Statement_Exception

     */

    public function fetchObject($class = 'stdClass', array $config = array());

    /**

     * Retrieve a statement attribute.

     *

     * @param string $key Attribute name.

     * @return mixed      Attribute value.

     * @throws Zend_Db_Statement_Exception

     */

    public function getAttribute($key);

    /**

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

     *

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function nextRowset();

    /**

     * Returns the number of rows affected by the execution of the

     * last INSERT, DELETE, or UPDATE statement executed by this

     * statement object.

     *

     * @return int     The number of rows affected.

     * @throws Zend_Db_Statement_Exception

     */

    public function rowCount();

    /**

     * Set a statement attribute.

     *

     * @param string $key Attribute name.

     * @param mixed  $val Attribute value.

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function setAttribute($key, $val);

    /**

     * Set the default fetch mode for this statement.

     *

     * @param int   $mode The fetch mode.

     * @return bool

     * @throws Zend_Db_Statement_Exception

     */

    public function setFetchMode($mode);

}