<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title>Docs For Class ZendX_Db_Statement_Firebird</title> <link rel="stylesheet" href="../../media/stylesheet.css" /> <script src="../../media/lib/classTree.js"></script> <script language="javascript" type="text/javascript"> var imgPlus = new Image(); var imgMinus = new Image(); imgPlus.src = "../../media/images/plus.png"; imgMinus.src = "../../media/images/minus.png"; function showNode(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; var oImg = document.layers["img" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; var oImg = document.all["img" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); var oImg = document.getElementById("img" + Node); break; } oImg.src = imgMinus.src; oTable.style.display = "block"; } function hideNode(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; var oImg = document.layers["img" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; var oImg = document.all["img" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); var oImg = document.getElementById("img" + Node); break; } oImg.src = imgPlus.src; oTable.style.display = "none"; } function nodeIsVisible(Node){ switch(navigator.family){ case 'nn4': // Nav 4.x code fork... var oTable = document.layers["span" + Node]; break; case 'ie4': // IE 4/5 code fork... var oTable = document.all["span" + Node]; break; case 'gecko': // Standards Compliant code fork... var oTable = document.getElementById("span" + Node); break; } return (oTable && oTable.style.display == "block"); } function toggleNodeVisibility(Node){ if (nodeIsVisible(Node)){ hideNode(Node); }else{ showNode(Node); } } </script> </head> <body> <div class="page-body"> <h2 class="class-name"><img src="../../media/images/Class_logo.png" alt=" Class" title=" Class" style="vertical-align: middle"> ZendX_Db_Statement_Firebird</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Extends for Firebird</p> <ul class="tags"> <li><span class="field">copyright:</span> Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)</li> <li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li> </ul> <p class="notes"> Located in <a class="field" href="_Db---Statement---Firebird.php.html">/Db/Statement/Firebird.php</a> (line <span class="field">37</span>) </p> <pre>Zend_Db_Statement | --ZendX_Db_Statement_Firebird</pre> </div> </div> <a name="sec-var-summary"></a> <div class="info-box"> <div class="info-box-title">Variable Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="var-summary"> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">array</span> <a href="#$_keys" title="details" class="var-name">$_keys</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">array</span> <a href="#$_meta" title="details" class="var-name">$_meta</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">firebird_result</span> <a href="#$_stmtColumnCount" title="details" class="var-name">$_stmtColumnCount</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">firebird_stmtPrepared</span> <a href="#$_stmtPrepared" title="details" class="var-name">$_stmtPrepared</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">firebird_result</span> <a href="#$_stmtResult" title="details" class="var-name">$_stmtResult</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">firebird_result</span> <a href="#$_stmtRowCount" title="details" class="var-name">$_stmtRowCount</a> </div> <div class="var-title"> <img src="../../media/images/Variable.png" alt=" " /> <span class="var-type">array</span> <a href="#$_values" title="details" class="var-name">$_values</a> </div> </div> </div> </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">bool</span> <a href="#close" title="details" class="method-name">close</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">bool</span> <a href="#closeCursor" title="details" class="method-name">closeCursor</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">int</span> <a href="#columnCount" title="details" class="method-name">columnCount</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">string</span> <a href="#errorCode" title="details" class="method-name">errorCode</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">array</span> <a href="#errorInfo" title="details" class="method-name">errorInfo</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">mixed</span> <a href="#fetch" title="details" class="method-name">fetch</a> ([<span class="var-type">int</span> <span class="var-name">$style</span> = <span class="var-default">null</span>], [<span class="var-type">int</span> <span class="var-name">$cursor</span> = <span class="var-default">null</span>], [<span class="var-type">int</span> <span class="var-name">$offset</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">bool</span> <a href="#nextRowset" title="details" class="method-name">nextRowset</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">int</span> <a href="#rowCount" title="details" class="method-name">rowCount</a> () </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">bool</span> <a href="#_bindParam" title="details" class="method-name">_bindParam</a> (<span class="var-type">mixed</span> <span class="var-name">$parameter</span>, <span class="var-type"></span> <span class="var-name">&$variable</span>, [<span class="var-type">mixed</span> <span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span> <span class="var-name">$length</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span> <span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">mixed</span> <span class="var-name">$variable</span>) </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">bool</span> <a href="#_execute" title="details" class="method-name">_execute</a> ([<span class="var-type"></span> <span class="var-name">$params</span> = <span class="var-default">null</span>]) </div> <div class="method-definition"> <img src="../../media/images/Method.png" alt=" "/> <span class="method-result">void</span> <a href="#_prepare" title="details" class="method-name">_prepare</a> (<span class="var-type">string</span> <span class="var-name">$sql</span>) </div> </div> </div> </div> <a name="sec-vars"></a> <div class="info-box"> <div class="info-box-title">Variables</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <a name="var$_keys" id="$_keys"><!-- --></A> <div class="oddrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$_keys</span> = <span class="var-default">array()</span> (line <span class="line-number">73</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Column names.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_meta" id="$_meta"><!-- --></A> <div class="evenrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$_meta</span> = <span class="var-default"> null</span> (line <span class="line-number">85</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_stmtColumnCount" id="$_stmtColumnCount"><!-- --></A> <div class="oddrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">firebird_result</span> <span class="var-name">$_stmtColumnCount</span> = <span class="var-default"> 0</span> (line <span class="line-number">66</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">The firebird_stmtResult resource.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_stmtPrepared" id="$_stmtPrepared"><!-- --></A> <div class="evenrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">firebird_stmtPrepared</span> <span class="var-name">$_stmtPrepared</span> = <span class="var-default"> null</span> (line <span class="line-number">45</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">The firebird_stmtPrepared resource.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_stmtResult" id="$_stmtResult"><!-- --></A> <div class="oddrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">firebird_result</span> <span class="var-name">$_stmtResult</span> = <span class="var-default"> null</span> (line <span class="line-number">52</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">The firebird_stmtResult resource.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_stmtRowCount" id="$_stmtRowCount"><!-- --></A> <div class="evenrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">firebird_result</span> <span class="var-name">$_stmtRowCount</span> = <span class="var-default"> 0</span> (line <span class="line-number">59</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">The firebird_stmtResult resource.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> <a name="var$_values" id="$_values"><!-- --></A> <div class="oddrow"> <div class="var-header"> <img src="../../media/images/Variable.png" /> <span class="var-title"> <span class="var-type">array</span> <span class="var-name">$_values</span> = <span class="var-default">array()</span> (line <span class="line-number">80</span>) </span> </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Fetched result values.</p> <ul class="tags"> <li><span class="field">access:</span> protected</li> </ul> </div> </div> </div> <a name="sec-methods"></a> <div class="info-box"> <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> <div class="info-box-body"> <A NAME='method_detail'></A> <a name="methodclose" id="close"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">close</span> (line <span class="line-number">134</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Closes the cursor and the statement.</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> close </span> () </div> </div> <a name="methodcloseCursor" id="closeCursor"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">closeCursor</span> (line <span class="line-number">154</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Closes the cursor, allowing the statement to be executed again.</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> closeCursor </span> () </div> </div> <a name="methodcolumnCount" id="columnCount"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">columnCount</span> (line <span class="line-number">168</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Returns the number of columns in the result set.</p> <p class="description"><p>Returns null if the statement has no result set metadata.</p></p> <ul class="tags"> <li><span class="field">return:</span> The number of columns.</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> columnCount </span> () </div> </div> <a name="methoderrorCode" id="errorCode"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">errorCode</span> (line <span class="line-number">179</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Retrieves the error code, if any, associated with the last operation on the statement handle.</p> <ul class="tags"> <li><span class="field">return:</span> error code.</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">string</span> <span class="method-name"> errorCode </span> () </div> </div> <a name="methoderrorInfo" id="errorInfo"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">errorInfo</span> (line <span class="line-number">193</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Retrieves an array of error information, if any, associated with the last operation on the statement handle.</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> errorInfo </span> () </div> </div> <a name="methodfetch" id="fetch"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">fetch</span> (line <span class="line-number">292</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Fetches a row from the result set.</p> <ul class="tags"> <li><span class="field">return:</span> Array, object, or scalar depending on fetch mode.</li> <li><span class="field">throws:</span> Zend_Db_Statement_Exception</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">mixed</span> <span class="method-name"> fetch </span> ([<span class="var-type">int</span> <span class="var-name">$style</span> = <span class="var-default">null</span>], [<span class="var-type">int</span> <span class="var-name">$cursor</span> = <span class="var-default">null</span>], [<span class="var-type">int</span> <span class="var-name">$offset</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">int</span> <span class="var-name">$style</span><span class="var-description">: OPTIONAL Fetch mode for this fetch operation.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$cursor</span><span class="var-description">: OPTIONAL Absolute, relative, or other.</span> </li> <li> <span class="var-type">int</span> <span class="var-name">$offset</span><span class="var-description">: OPTIONAL Number for absolute or relative cursors.</span> </li> </ul> </div> <a name="methodnextRowset" id="nextRowset"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">nextRowset</span> (line <span class="line-number">347</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">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.</p> <ul class="tags"> <li><span class="field">throws:</span> ZendX_Db_Statement_Firebird_Exception</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> nextRowset </span> () </div> </div> <a name="methodrowCount" id="rowCount"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">rowCount</span> (line <span class="line-number">364</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Returns the number of rows affected by the execution of the last INSERT, DELETE, or UPDATE statement executed by this statement object.</p> <ul class="tags"> <li><span class="field">return:</span> The number of rows affected.</li> <li><span class="field">throws:</span> Zend_Db_Statement_Exception</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">int</span> <span class="method-name"> rowCount </span> () </div> </div> <a name="method_bindParam" id="_bindParam"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">_bindParam</span> (line <span class="line-number">124</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Binds a parameter to the specified variable name.</p> <ul class="tags"> <li><span class="field">throws:</span> ZendX_Db_Statement_Firebird_Exception</li> <li><span class="field">access:</span> protected</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> _bindParam </span> (<span class="var-type">mixed</span> <span class="var-name">$parameter</span>, <span class="var-type"></span> <span class="var-name">&$variable</span>, [<span class="var-type">mixed</span> <span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span> <span class="var-name">$length</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span> <span class="var-name">$options</span> = <span class="var-default">null</span>], <span class="var-type">mixed</span> <span class="var-name">$variable</span>) </div> <ul class="parameters"> <li> <span class="var-type">mixed</span> <span class="var-name">$parameter</span><span class="var-description">: Name the parameter, either integer or string.</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$variable</span><span class="var-description">: Reference to PHP variable containing the value.</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$type</span><span class="var-description">: OPTIONAL Datatype of SQL parameter.</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$length</span><span class="var-description">: OPTIONAL Length of SQL parameter.</span> </li> <li> <span class="var-type">mixed</span> <span class="var-name">$options</span><span class="var-description">: OPTIONAL Other options.</span> </li> <li> <span class="var-type"></span> <span class="var-name">&$variable</span> </li> </ul> </div> <a name="method_execute" id="_execute"><!-- --></a> <div class="oddrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">_execute</span> (line <span class="line-number">211</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Executes a prepared statement.</p> <ul class="tags"> <li><span class="field">throws:</span> ZendX_Db_Statement_Firebird_Exception</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">bool</span> <span class="method-name"> _execute </span> ([<span class="var-type"></span> <span class="var-name">$params</span> = <span class="var-default">null</span>]) </div> <ul class="parameters"> <li> <span class="var-type">array</span> <span class="var-name">$params</span><span class="var-description">: OPTIONAL Values to bind to parameter placeholders.</span> </li> </ul> </div> <a name="method_prepare" id="_prepare"><!-- --></a> <div class="evenrow"> <div class="method-header"> <img src="../../media/images/Method.png" /> <span class="method-title">_prepare</span> (line <span class="line-number">92</span>) </div> <!-- ========== Info from phpDoc block ========= --> <ul class="tags"> <li><span class="field">throws:</span> ZendX_Db_Statement_Firebird_Exception</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> _prepare </span> (<span class="var-type">string</span> <span class="var-name">$sql</span>) </div> <ul class="parameters"> <li> <span class="var-type">string</span> <span class="var-name">$sql</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Sat, 14 Feb 2009 13:36:22 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html>