283 lines
71 KiB
HTML
283 lines
71 KiB
HTML
|
|
<div id="content">
|
|
<h1 align="center">Source for file Interface.php</h1>
|
|
<p>Documentation is available at <a href="../Doctrine/_Doctrine---Adapter---Statement---Interface.php.html">Interface.php</a></p>
|
|
<div class="src-code"><span class="php">
|
|
<ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
|
|
<li><div class="src-line"><a name="a2"></a><span class="src-comm">/*</span></div></li>
|
|
<li><div class="src-line"><a name="a3"></a><span class="src-comm"> * $Id: Interface.php 1080 2007-02-10 18:17:08Z romanb $</span></div></li>
|
|
<li><div class="src-line"><a name="a4"></a><span class="src-comm"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a5"></a><span class="src-comm"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div></li>
|
|
<li><div class="src-line"><a name="a6"></a><span class="src-comm"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div></li>
|
|
<li><div class="src-line"><a name="a7"></a><span class="src-comm"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div></li>
|
|
<li><div class="src-line"><a name="a8"></a><span class="src-comm"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div></li>
|
|
<li><div class="src-line"><a name="a9"></a><span class="src-comm"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div></li>
|
|
<li><div class="src-line"><a name="a10"></a><span class="src-comm"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div></li>
|
|
<li><div class="src-line"><a name="a11"></a><span class="src-comm"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div></li>
|
|
<li><div class="src-line"><a name="a12"></a><span class="src-comm"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div></li>
|
|
<li><div class="src-line"><a name="a13"></a><span class="src-comm"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div></li>
|
|
<li><div class="src-line"><a name="a14"></a><span class="src-comm"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div></li>
|
|
<li><div class="src-line"><a name="a15"></a><span class="src-comm"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div></li>
|
|
<li><div class="src-line"><a name="a16"></a><span class="src-comm"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a17"></a><span class="src-comm"> * This software consists of voluntary contributions made by many individuals</span></div></li>
|
|
<li><div class="src-line"><a name="a18"></a><span class="src-comm"> * and is licensed under the LGPL. For more information, see</span></div></li>
|
|
<li><div class="src-line"><a name="a19"></a><span class="src-comm"> * <http://www.phpdoctrine.com>.</span></div></li>
|
|
<li><div class="src-line"><a name="a20"></a><span class="src-comm"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a21"></a><span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a22"></a><span class="src-doc"> * Doctrine_Adapter_Statement</span></div></li>
|
|
<li><div class="src-line"><a name="a23"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a24"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Konsta Vesterinen <kvesteri@cc.hut.fi></span></div></li>
|
|
<li><div class="src-line"><a name="a25"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.opensource.org/licenses/lgpl-license.php LGPL</span></div></li>
|
|
<li><div class="src-line"><a name="a26"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> Doctrine</span></div></li>
|
|
<li><div class="src-line"><a name="a27"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@category</span><span class="src-doc"> Object Relational Mapping</span></div></li>
|
|
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@link</span><span class="src-doc"> www.phpdoctrine.com</span></div></li>
|
|
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@since</span><span class="src-doc"> 1.0</span></div></li>
|
|
<li><div class="src-line"><a name="a30"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Revision: 1080 $</span></div></li>
|
|
<li><div class="src-line"><a name="a31"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a32"></a><span class="src-key">interface </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html">Doctrine_Adapter_Statement_Interface</a></div></li>
|
|
<li><div class="src-line"><a name="a33"></a><span class="src-sym">{ </span></div></li>
|
|
<li><div class="src-line"><a name="a34"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * bindColumn</span></div></li>
|
|
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> * Bind a column to a PHP variable</span></div></li>
|
|
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a38"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$column </span><span class="src-doc"> Number of the column (1-indexed) or name of the column in the result set.</span></div></li>
|
|
<li><div class="src-line"><a name="a39"></a><span class="src-doc"> * If using the column name, be aware that the name should match</span></div></li>
|
|
<li><div class="src-line"><a name="a40"></a><span class="src-doc"> * the case of the column, as returned by the driver.</span></div></li>
|
|
<li><div class="src-line"><a name="a41"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$param </span><span class="src-doc"> Name of the PHP variable to which the column will be bound.</span></div></li>
|
|
<li><div class="src-line"><a name="a42"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$type </span><span class="src-doc"> Data type of the parameter, specified by the Doctrine::PARAM_* constants.</span></div></li>
|
|
<li><div class="src-line"><a name="a43"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure</span></div></li>
|
|
<li><div class="src-line"><a name="a44"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a45"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodbindColumn">bindColumn</a><span class="src-sym">(</span><span class="src-var">$column</span><span class="src-sym">, </span><span class="src-var">$param</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a46"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a47"></a><span class="src-doc"> * bindValue</span></div></li>
|
|
<li><div class="src-line"><a name="a48"></a><span class="src-doc"> * Binds a value to a corresponding named or question mark</span></div></li>
|
|
<li><div class="src-line"><a name="a49"></a><span class="src-doc"> * placeholder in the SQL statement that was use to prepare the statement.</span></div></li>
|
|
<li><div class="src-line"><a name="a50"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a51"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$param </span><span class="src-doc"> Parameter identifier. For a prepared statement using named placeholders,</span></div></li>
|
|
<li><div class="src-line"><a name="a52"></a><span class="src-doc"> * this will be a parameter name of the form :name. For a prepared statement</span></div></li>
|
|
<li><div class="src-line"><a name="a53"></a><span class="src-doc"> * using question mark placeholders, this will be the 1-indexed position of the parameter</span></div></li>
|
|
<li><div class="src-line"><a name="a54"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a55"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$value </span><span class="src-doc"> The value to bind to the parameter.</span></div></li>
|
|
<li><div class="src-line"><a name="a56"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$type </span><span class="src-doc"> Explicit data type for the parameter using the Doctrine::PARAM_* constants.</span></div></li>
|
|
<li><div class="src-line"><a name="a57"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a59"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a60"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodbindValue">bindValue</a><span class="src-sym">(</span><span class="src-var">$param</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a61"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> * bindParam</span></div></li>
|
|
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> * Binds a PHP variable to a corresponding named or question mark placeholder in the</span></div></li>
|
|
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> * SQL statement that was use to prepare the statement. Unlike Doctrine_Adapter_Statement_Interface->bindValue(),</span></div></li>
|
|
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> * the variable is bound as a reference and will only be evaluated at the time</span></div></li>
|
|
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> * that Doctrine_Adapter_Statement_Interface->execute() is called.</span></div></li>
|
|
<li><div class="src-line"><a name="a67"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a68"></a><span class="src-doc"> * Most parameters are input parameters, that is, parameters that are</span></div></li>
|
|
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * used in a read-only fashion to build up the query. Some drivers support the invocation</span></div></li>
|
|
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * of stored procedures that return data as output parameters, and some also as input/output</span></div></li>
|
|
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> * parameters that both send in data and are updated to receive it.</span></div></li>
|
|
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$param </span><span class="src-doc"> Parameter identifier. For a prepared statement using named placeholders,</span></div></li>
|
|
<li><div class="src-line"><a name="a74"></a><span class="src-doc"> * this will be a parameter name of the form :name. For a prepared statement</span></div></li>
|
|
<li><div class="src-line"><a name="a75"></a><span class="src-doc"> * using question mark placeholders, this will be the 1-indexed position of the parameter</span></div></li>
|
|
<li><div class="src-line"><a name="a76"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a77"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$variable </span><span class="src-doc"> Name of the PHP variable to bind to the SQL statement parameter.</span></div></li>
|
|
<li><div class="src-line"><a name="a78"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a79"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$type </span><span class="src-doc"> Explicit data type for the parameter using the Doctrine::PARAM_* constants. To return</span></div></li>
|
|
<li><div class="src-line"><a name="a80"></a><span class="src-doc"> * an INOUT parameter from a stored procedure, use the bitwise OR operator to set the</span></div></li>
|
|
<li><div class="src-line"><a name="a81"></a><span class="src-doc"> * Doctrine::PARAM_INPUT_OUTPUT bits for the data_type parameter.</span></div></li>
|
|
<li><div class="src-line"><a name="a82"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a83"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$length </span><span class="src-doc"> Length of the data type. To indicate that a parameter is an OUT parameter</span></div></li>
|
|
<li><div class="src-line"><a name="a84"></a><span class="src-doc"> * from a stored procedure, you must explicitly set the length.</span></div></li>
|
|
<li><div class="src-line"><a name="a85"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$driverOptions </span></div></li>
|
|
<li><div class="src-line"><a name="a86"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a87"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a88"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodbindParam">bindParam</a><span class="src-sym">(</span><span class="src-var">$column</span><span class="src-sym">, </span><span class="src-var">$variable</span><span class="src-sym">, </span><span class="src-var">$type </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$length </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$driverOptions </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a89"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a90"></a><span class="src-doc"> * closeCursor</span></div></li>
|
|
<li><div class="src-line"><a name="a91"></a><span class="src-doc"> * Closes the cursor, enabling the statement to be executed again.</span></div></li>
|
|
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a94"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a95"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodcloseCursor">closeCursor</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a96"></a> <span class="src-doc">/** </span></div></li>
|
|
<li><div class="src-line"><a name="a97"></a><span class="src-doc"> * columnCount</span></div></li>
|
|
<li><div class="src-line"><a name="a98"></a><span class="src-doc"> * Returns the number of columns in the result set</span></div></li>
|
|
<li><div class="src-line"><a name="a99"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a100"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">integer </span><span class="src-doc"> Returns the number of columns in the result set represented</span></div></li>
|
|
<li><div class="src-line"><a name="a101"></a><span class="src-doc"> * by the Doctrine_Adapter_Statement_Interface object. If there is no result set,</span></div></li>
|
|
<li><div class="src-line"><a name="a102"></a><span class="src-doc"> * this method should return 0.</span></div></li>
|
|
<li><div class="src-line"><a name="a103"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a104"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodcolumnCount">columnCount</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a105"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a106"></a><span class="src-doc"> * errorCode</span></div></li>
|
|
<li><div class="src-line"><a name="a107"></a><span class="src-doc"> * Fetch the SQLSTATE associated with the last operation on the statement handle</span></div></li>
|
|
<li><div class="src-line"><a name="a108"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a109"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> Doctrine_Adapter_Interface::errorCode()</span></div></li>
|
|
<li><div class="src-line"><a name="a110"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc"> error code string</span></div></li>
|
|
<li><div class="src-line"><a name="a111"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a112"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methoderrorCode">errorCode</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a113"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a114"></a><span class="src-doc"> * errorInfo</span></div></li>
|
|
<li><div class="src-line"><a name="a115"></a><span class="src-doc"> * Fetch extended error information associated with the last operation on the statement handle</span></div></li>
|
|
<li><div class="src-line"><a name="a116"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a117"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> Doctrine_Adapter_Interface::errorInfo()</span></div></li>
|
|
<li><div class="src-line"><a name="a118"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc"> error info array</span></div></li>
|
|
<li><div class="src-line"><a name="a119"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a120"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methoderrorInfo">errorInfo</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a121"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a122"></a><span class="src-doc"> * execute</span></div></li>
|
|
<li><div class="src-line"><a name="a123"></a><span class="src-doc"> * Executes a prepared statement</span></div></li>
|
|
<li><div class="src-line"><a name="a124"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a125"></a><span class="src-doc"> * If the prepared statement included parameter markers, you must either:</span></div></li>
|
|
<li><div class="src-line"><a name="a126"></a><span class="src-doc"> * call PDOStatement->bindParam() to bind PHP variables to the parameter markers:</span></div></li>
|
|
<li><div class="src-line"><a name="a127"></a><span class="src-doc"> * bound variables pass their value as input and receive the output value,</span></div></li>
|
|
<li><div class="src-line"><a name="a128"></a><span class="src-doc"> * if any, of their associated parameter markers or pass an array of input-only</span></div></li>
|
|
<li><div class="src-line"><a name="a129"></a><span class="src-doc"> * parameter values</span></div></li>
|
|
<li><div class="src-line"><a name="a130"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a131"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a132"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$params </span><span class="src-doc"> An array of values with as many elements as there are</span></div></li>
|
|
<li><div class="src-line"><a name="a133"></a><span class="src-doc"> * bound parameters in the SQL statement being executed.</span></div></li>
|
|
<li><div class="src-line"><a name="a134"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a135"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a136"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodexecute">execute</a><span class="src-sym">(</span><span class="src-var">$params </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a137"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a138"></a><span class="src-doc"> * fetch</span></div></li>
|
|
<li><div class="src-line"><a name="a139"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a140"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> Doctrine::FETCH_* constants</span></div></li>
|
|
<li><div class="src-line"><a name="a141"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$fetchStyle </span><span class="src-doc"> Controls how the next row will be returned to the caller.</span></div></li>
|
|
<li><div class="src-line"><a name="a142"></a><span class="src-doc"> * This value must be one of the Doctrine::FETCH_* constants,</span></div></li>
|
|
<li><div class="src-line"><a name="a143"></a><span class="src-doc"> * defaulting to Doctrine::FETCH_BOTH</span></div></li>
|
|
<li><div class="src-line"><a name="a144"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a145"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$cursorOrientation </span><span class="src-doc"> For a PDOStatement object representing a scrollable cursor,</span></div></li>
|
|
<li><div class="src-line"><a name="a146"></a><span class="src-doc"> * this value determines which row will be returned to the caller.</span></div></li>
|
|
<li><div class="src-line"><a name="a147"></a><span class="src-doc"> * This value must be one of the Doctrine::FETCH_ORI_* constants, defaulting to</span></div></li>
|
|
<li><div class="src-line"><a name="a148"></a><span class="src-doc"> * Doctrine::FETCH_ORI_NEXT. To request a scrollable cursor for your</span></div></li>
|
|
<li><div class="src-line"><a name="a149"></a><span class="src-doc"> * Doctrine_Adapter_Statement_Interface object,</span></div></li>
|
|
<li><div class="src-line"><a name="a150"></a><span class="src-doc"> * you must set the Doctrine::ATTR_CURSOR attribute to Doctrine::CURSOR_SCROLL when you</span></div></li>
|
|
<li><div class="src-line"><a name="a151"></a><span class="src-doc"> * prepare the SQL statement with Doctrine_Adapter_Interface->prepare().</span></div></li>
|
|
<li><div class="src-line"><a name="a152"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a153"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$cursorOffset </span><span class="src-doc"> For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for which the</span></div></li>
|
|
<li><div class="src-line"><a name="a154"></a><span class="src-doc"> * $cursorOrientation parameter is set to Doctrine::FETCH_ORI_ABS, this value specifies</span></div></li>
|
|
<li><div class="src-line"><a name="a155"></a><span class="src-doc"> * the absolute number of the row in the result set that shall be fetched.</span></div></li>
|
|
<li><div class="src-line"><a name="a156"></a><span class="src-doc"> * </span></div></li>
|
|
<li><div class="src-line"><a name="a157"></a><span class="src-doc"> * For a Doctrine_Adapter_Statement_Interface object representing a scrollable cursor for</span></div></li>
|
|
<li><div class="src-line"><a name="a158"></a><span class="src-doc"> * which the $cursorOrientation parameter is set to Doctrine::FETCH_ORI_REL, this value</span></div></li>
|
|
<li><div class="src-line"><a name="a159"></a><span class="src-doc"> * specifies the row to fetch relative to the cursor position before</span></div></li>
|
|
<li><div class="src-line"><a name="a160"></a><span class="src-doc"> * Doctrine_Adapter_Statement_Interface->fetch() was called.</span></div></li>
|
|
<li><div class="src-line"><a name="a161"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a162"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span></div></li>
|
|
<li><div class="src-line"><a name="a163"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a164"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodfetch">fetch</a><span class="src-sym">(</span><span class="src-var">$fetchStyle </span>= <span class="src-id">Doctrine</span><span class="src-sym">::</span><span class="src-id">FETCH_BOTH</span><span class="src-sym">,</span></div></li>
|
|
<li><div class="src-line"><a name="a165"></a> <span class="src-var">$cursorOrientation </span>= <span class="src-id">Doctrine</span><span class="src-sym">::</span><span class="src-id">FETCH_ORI_NEXT</span><span class="src-sym">,</span></div></li>
|
|
<li><div class="src-line"><a name="a166"></a> <span class="src-var">$cursorOffset </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a167"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a168"></a><span class="src-doc"> * fetchAll</span></div></li>
|
|
<li><div class="src-line"><a name="a169"></a><span class="src-doc"> * Returns an array containing all of the result set rows</span></div></li>
|
|
<li><div class="src-line"><a name="a170"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a171"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$fetchStyle </span><span class="src-doc"> Controls how the next row will be returned to the caller.</span></div></li>
|
|
<li><div class="src-line"><a name="a172"></a><span class="src-doc"> * This value must be one of the Doctrine::FETCH_* constants,</span></div></li>
|
|
<li><div class="src-line"><a name="a173"></a><span class="src-doc"> * defaulting to Doctrine::FETCH_BOTH</span></div></li>
|
|
<li><div class="src-line"><a name="a174"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a175"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$columnIndex </span><span class="src-doc"> Returns the indicated 0-indexed column when the value of $fetchStyle is</span></div></li>
|
|
<li><div class="src-line"><a name="a176"></a><span class="src-doc"> * Doctrine::FETCH_COLUMN. Defaults to 0.</span></div></li>
|
|
<li><div class="src-line"><a name="a177"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a178"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span></div></li>
|
|
<li><div class="src-line"><a name="a179"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a180"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodfetchAll">fetchAll</a><span class="src-sym">(</span><span class="src-var">$fetchStyle </span>= <span class="src-id">Doctrine</span><span class="src-sym">::</span><span class="src-id">FETCH_BOTH</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a181"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a182"></a><span class="src-doc"> * fetchColumn</span></div></li>
|
|
<li><div class="src-line"><a name="a183"></a><span class="src-doc"> * Returns a single column from the next row of a</span></div></li>
|
|
<li><div class="src-line"><a name="a184"></a><span class="src-doc"> * result set or FALSE if there are no more rows.</span></div></li>
|
|
<li><div class="src-line"><a name="a185"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a186"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$columnIndex </span><span class="src-doc"> 0-indexed number of the column you wish to retrieve from the row. If no</span></div></li>
|
|
<li><div class="src-line"><a name="a187"></a><span class="src-doc"> * value is supplied, Doctrine_Adapter_Statement_Interface->fetchColumn()</span></div></li>
|
|
<li><div class="src-line"><a name="a188"></a><span class="src-doc"> * fetches the first column.</span></div></li>
|
|
<li><div class="src-line"><a name="a189"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a190"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc"> returns a single column in the next row of a result set.</span></div></li>
|
|
<li><div class="src-line"><a name="a191"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a192"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodfetchColumn">fetchColumn</a><span class="src-sym">(</span><span class="src-var">$columnIndex </span>= <span class="src-num">0</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a193"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a194"></a><span class="src-doc"> * fetchObject</span></div></li>
|
|
<li><div class="src-line"><a name="a195"></a><span class="src-doc"> * Fetches the next row and returns it as an object.</span></div></li>
|
|
<li><div class="src-line"><a name="a196"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a197"></a><span class="src-doc"> * Fetches the next row and returns it as an object. This function is an alternative to</span></div></li>
|
|
<li><div class="src-line"><a name="a198"></a><span class="src-doc"> * Doctrine_Adapter_Statement_Interface->fetch() with Doctrine::FETCH_CLASS or Doctrine::FETCH_OBJ style.</span></div></li>
|
|
<li><div class="src-line"><a name="a199"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a200"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$className </span><span class="src-doc"> Name of the created class, defaults to stdClass.</span></div></li>
|
|
<li><div class="src-line"><a name="a201"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">array </span><span class="src-doc-var">$args </span><span class="src-doc"> Elements of this array are passed to the constructor.</span></div></li>
|
|
<li><div class="src-line"><a name="a202"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a203"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc"> an instance of the required class with property names that correspond</span></div></li>
|
|
<li><div class="src-line"><a name="a204"></a><span class="src-doc"> * to the column names or FALSE in case of an error.</span></div></li>
|
|
<li><div class="src-line"><a name="a205"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a206"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodfetchObject">fetchObject</a><span class="src-sym">(</span><span class="src-var">$className </span>= <span class="src-str">'stdClass'</span><span class="src-sym">, </span><span class="src-var">$args </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a207"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a208"></a><span class="src-doc"> * getAttribute</span></div></li>
|
|
<li><div class="src-line"><a name="a209"></a><span class="src-doc"> * Retrieve a statement attribute</span></div></li>
|
|
<li><div class="src-line"><a name="a210"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a211"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$attribute </span></div></li>
|
|
<li><div class="src-line"><a name="a212"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@see</span><span class="src-doc"> Doctrine::ATTR_* constants</span></div></li>
|
|
<li><div class="src-line"><a name="a213"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">mixed </span><span class="src-doc"> the attribute value</span></div></li>
|
|
<li><div class="src-line"><a name="a214"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a215"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodgetAttribute">getAttribute</a><span class="src-sym">(</span><span class="src-var">$attribute</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a216"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a217"></a><span class="src-doc"> * getColumnMeta</span></div></li>
|
|
<li><div class="src-line"><a name="a218"></a><span class="src-doc"> * Returns metadata for a column in a result set</span></div></li>
|
|
<li><div class="src-line"><a name="a219"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a220"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$column </span><span class="src-doc"> The 0-indexed column in the result set.</span></div></li>
|
|
<li><div class="src-line"><a name="a221"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a222"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">array </span><span class="src-doc"> Associative meta data array with the following structure:</span></div></li>
|
|
<li><div class="src-line"><a name="a223"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a224"></a><span class="src-doc"> * native_type The PHP native type used to represent the column value.</span></div></li>
|
|
<li><div class="src-line"><a name="a225"></a><span class="src-doc"> * driver:decl_ type The SQL type used to represent the column value in the database. If the column in the result set is the result of a function, this value is not returned by PDOStatement->getColumnMeta().</span></div></li>
|
|
<li><div class="src-line"><a name="a226"></a><span class="src-doc"> * flags Any flags set for this column.</span></div></li>
|
|
<li><div class="src-line"><a name="a227"></a><span class="src-doc"> * name The name of this column as returned by the database.</span></div></li>
|
|
<li><div class="src-line"><a name="a228"></a><span class="src-doc"> * len The length of this column. Normally -1 for types other than floating point decimals.</span></div></li>
|
|
<li><div class="src-line"><a name="a229"></a><span class="src-doc"> * precision The numeric precision of this column. Normally 0 for types other than floating point decimals.</span></div></li>
|
|
<li><div class="src-line"><a name="a230"></a><span class="src-doc"> * pdo_type The type of this column as represented by the PDO::PARAM_* constants.</span></div></li>
|
|
<li><div class="src-line"><a name="a231"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a232"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodgetColumnMeta">getColumnMeta</a><span class="src-sym">(</span><span class="src-var">$column</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a233"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a234"></a><span class="src-doc"> * nextRowset</span></div></li>
|
|
<li><div class="src-line"><a name="a235"></a><span class="src-doc"> * Advances to the next rowset in a multi-rowset statement handle</span></div></li>
|
|
<li><div class="src-line"><a name="a236"></a><span class="src-doc"> * </span></div></li>
|
|
<li><div class="src-line"><a name="a237"></a><span class="src-doc"> * Some database servers support stored procedures that return more than one rowset</span></div></li>
|
|
<li><div class="src-line"><a name="a238"></a><span class="src-doc"> * (also known as a result set). The nextRowset() method enables you to access the second</span></div></li>
|
|
<li><div class="src-line"><a name="a239"></a><span class="src-doc"> * and subsequent rowsets associated with a PDOStatement object. Each rowset can have a</span></div></li>
|
|
<li><div class="src-line"><a name="a240"></a><span class="src-doc"> * different set of columns from the preceding rowset.</span></div></li>
|
|
<li><div class="src-line"><a name="a241"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a242"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a243"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a244"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodnextRowset">nextRowset</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a245"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a246"></a><span class="src-doc"> * rowCount</span></div></li>
|
|
<li><div class="src-line"><a name="a247"></a><span class="src-doc"> * rowCount() returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement</span></div></li>
|
|
<li><div class="src-line"><a name="a248"></a><span class="src-doc"> * executed by the corresponding object.</span></div></li>
|
|
<li><div class="src-line"><a name="a249"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a250"></a><span class="src-doc"> * If the last SQL statement executed by the associated Statement object was a SELECT statement,</span></div></li>
|
|
<li><div class="src-line"><a name="a251"></a><span class="src-doc"> * some databases may return the number of rows returned by that statement. However,</span></div></li>
|
|
<li><div class="src-line"><a name="a252"></a><span class="src-doc"> * this behaviour is not guaranteed for all databases and should not be</span></div></li>
|
|
<li><div class="src-line"><a name="a253"></a><span class="src-doc"> * relied on for portable applications.</span></div></li>
|
|
<li><div class="src-line"><a name="a254"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a255"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">integer </span><span class="src-doc"> Returns the number of rows.</span></div></li>
|
|
<li><div class="src-line"><a name="a256"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a257"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodrowCount">rowCount</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a258"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a259"></a><span class="src-doc"> * setAttribute</span></div></li>
|
|
<li><div class="src-line"><a name="a260"></a><span class="src-doc"> * Set a statement attribute</span></div></li>
|
|
<li><div class="src-line"><a name="a261"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a262"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$attribute </span></div></li>
|
|
<li><div class="src-line"><a name="a263"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">mixed </span><span class="src-doc-var">$value </span><span class="src-doc"> the value of given attribute</span></div></li>
|
|
<li><div class="src-line"><a name="a264"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns TRUE on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a265"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a266"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodsetAttribute">setAttribute</a><span class="src-sym">(</span><span class="src-var">$attribute</span><span class="src-sym">, </span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a267"></a> <span class="src-doc">/**</span></div></li>
|
|
<li><div class="src-line"><a name="a268"></a><span class="src-doc"> * setFetchMode</span></div></li>
|
|
<li><div class="src-line"><a name="a269"></a><span class="src-doc"> * Set the default fetch mode for this statement</span></div></li>
|
|
<li><div class="src-line"><a name="a270"></a><span class="src-doc"> *</span></div></li>
|
|
<li><div class="src-line"><a name="a271"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">integer </span><span class="src-doc-var">$mode </span><span class="src-doc"> The fetch mode must be one of the Doctrine::FETCH_* constants.</span></div></li>
|
|
<li><div class="src-line"><a name="a272"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">boolean </span><span class="src-doc"> Returns 1 on success or FALSE on failure.</span></div></li>
|
|
<li><div class="src-line"><a name="a273"></a><span class="src-doc"> */</span></div></li>
|
|
<li><div class="src-line"><a name="a274"></a> <span class="src-key">public </span><span class="src-key">function </span><a href="../Doctrine/Doctrine_Adapter_Statement_Interface.html#methodsetFetchMode">setFetchMode</a><span class="src-sym">(</span><span class="src-var">$mode</span><span class="src-sym">, </span><span class="src-var">$arg1 </span>= <span class="src-id">null</span><span class="src-sym">, </span><span class="src-var">$arg2 </span>= <span class="src-id">null</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
|
<li><div class="src-line"><a name="a275"></a><span class="src-sym">}</span></div></li>
|
|
</ol>
|
|
</span></div>
|
|
</div> |