--no commit message

--no commit message

lib/Doctrine/Adapter/Statement/Interface.php

@@ -51,8 +51,10 @@ interface Doctrine_Adapter_Statement_Interface
      * @param mixed $param          Parameter identifier. For a prepared statement using named placeholders,
      *                              this will be a parameter name of the form :name. For a prepared statement
      *                              using question mark placeholders, this will be the 1-indexed position of the parameter
+     *
      * @param mixed $value          The value to bind to the parameter.
      * @param integer $type         Explicit data type for the parameter using the Doctrine::PARAM_* constants.
+     *
      * @return boolean              Returns TRUE on success or FALSE on failure.
      */
     public function bindValue($param, $value, $type = null);
@@ -71,23 +73,114 @@ interface Doctrine_Adapter_Statement_Interface
      * @param mixed $param          Parameter identifier. For a prepared statement using named placeholders,
      *                              this will be a parameter name of the form :name. For a prepared statement
      *                              using question mark placeholders, this will be the 1-indexed position of the parameter
+     *
      * @param mixed $variable       Name of the PHP variable to bind to the SQL statement parameter.
+     *
      * @param integer $type         Explicit data type for the parameter using the Doctrine::PARAM_* constants. To return
      *                              an INOUT parameter from a stored procedure, use the bitwise OR operator to set the
      *                              Doctrine::PARAM_INPUT_OUTPUT bits for the data_type parameter.
+     *
      * @param integer $length       Length of the data type. To indicate that a parameter is an OUT parameter
      *                              from a stored procedure, you must explicitly set the length.
      * @param mixed $driverOptions
      * @return boolean              Returns TRUE on success or FALSE on failure.
      */
     public function bindParam($column, $variable, $type = null, $length = null, $driverOptions);
+    /**
+     * closeCursor
+     * Closes the cursor, enabling the statement to be executed again.
+     *
+     * @return boolean              Returns TRUE on success or FALSE on failure.
+     */
     public function closeCursor();
-    public function fetch();
-    public function nextRowset();
-    public function execute();
+    /** 
+     * columnCount
+     * Returns the number of columns in the result set 
+     *
+     * @return integer              Returns the number of columns in the result set represented
+     *                              by the Doctrine_Adapter_Statement_Interface object. If there is no result set,
+     *                              this method should return 0.
+     */
+    public function columnCount();
+    /**
+     * errorCode
+     * Fetch the SQLSTATE associated with the last operation on the statement handle 
+     *
+     * @see Doctrine_Adapter_Interface::errorCode()
+     * @return string       error code string
+     */
     public function errorCode();
+    /**
+     * errorInfo
+     * Fetch extended error information associated with the last operation on the statement handle
+     *
+     * @see Doctrine_Adapter_Interface::errorInfo()
+     * @return array        error info array
+     */
     public function errorInfo();
+    /**
+     * execute
+     * Executes a prepared statement
+     *
+     * If the prepared statement included parameter markers, you must either:
+     * call PDOStatement->bindParam() to bind PHP variables to the parameter markers:
+     * bound variables pass their value as input and receive the output value,
+     * if any, of their associated parameter markers or pass an array of input-only
+     * parameter values
+     *
+     *
+     * @param array $params             An array of values with as many elements as there are
+     *                                  bound parameters in the SQL statement being executed.
+     * @return boolean                  Returns TRUE on success or FALSE on failure.
+     */
+    public function execute($params);
+    /**
+     * fetch
+     *
+     * @see Doctrine::FETCH_* constants
+     * @param integer $fetchStyle           Controls how the next row will be returned to the caller.
+     *                                      This value must be one of the Doctrine::FETCH_* constants,
+     *                                      defaulting to Doctrine::FETCH_BOTH
+     *
+     * @param integer $cursorOrientation    For a PDOStatement object representing a scrollable cursor, 
+     *                                      this value determines which row will be returned to the caller. 
+     *                                      This value must be one of the Doctrine::FETCH_ORI_* constants, defaulting to
+     *                                      Doctrine::FETCH_ORI_NEXT. To request a scrollable cursor for your 
+     *                                      Doctrine_Adapter_Statement_Interface object,
+     *                                      you must set the Doctrine::ATTR_CURSOR attribute to Doctrine::CURSOR_SCROLL when you
+     *                                      prepare the SQL statement with Doctrine_Adapter_Interface->prepare().
+     *
+     * @param integer $cursorOffset         For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for which the
+     *                                      $cursorOrientation parameter is set to Doctrine::FETCH_ORI_ABS, this value specifies
+     *                                      the absolute number of the row in the result set that shall be fetched.
+     *                                      
+     *                                      For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for 
+     *                                      which the $cursorOrientation parameter is set to Doctrine::FETCH_ORI_REL, this value 
+     *                                      specifies the row to fetch relative to the cursor position before 
+     *                                      Doctrine_Adapter_Statement_Interface->fetch() was called.
+     *
+     * @return mixed
+     */
+    public function fetch($fetchStyle = Doctrine::FETCH_BOTH, 
+                          $cursorOrientation = Doctrine::FETCH_ORI_NEXT,
+                          $cursorOffset = null);
+    /**
+     * fetchAll
+     * Returns an array containing all of the result set rows
+     *
+     * 
+     *
+     * @param integer $columnIndex          Returns the indicated 0-indexed column when the value of $fetchStyle is
+     *                                      Doctrine::FETCH_COLUMN. Defaults to 0.
+     *
+     * @return array
+     */
+    public function fetchAll($fetchStyle = Doctrine::FETCH_BOTH,
+                             $columnIndex = 0);
+    public function nextRowset();
+
+
     public function rowCount();
     public function setFetchMode($mode);
-    public function columnCount();
+
 }