400 lines
19 KiB
HTML
400 lines
19 KiB
HTML
<!DOCTYPE html><html lang="en">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||
<meta charset="utf-8">
|
||
<title>Query » \Query\Driver\Firebird_Result</title>
|
||
<meta name="author" content="Mike van Riel">
|
||
<meta name="description" content="">
|
||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
|
||
</head>
|
||
<body>
|
||
<div class="navbar navbar-fixed-top">
|
||
<div class="navbar-inner"><div class="container">
|
||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
|
||
<li class="dropdown">
|
||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a>Namespaces</a></li>
|
||
<li><a href="../namespaces/Query.html"><i class="icon-th"></i> Query</a></li>
|
||
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
|
||
<li><a>Packages</a></li>
|
||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown" id="charts-menu">
|
||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||
</li>
|
||
<li class="dropdown" id="reports-menu">
|
||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||
<span class="label label-info">0</span></a></li>
|
||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||
<ul></ul></a></li>
|
||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||
<span class="label label-info">0</span></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul></div>
|
||
</div></div>
|
||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||
</div>
|
||
<div id="___" class="container">
|
||
<noscript><div class="alert alert-warning">
|
||
Javascript is disabled; several features are only available
|
||
if Javascript is enabled.
|
||
</div></noscript>
|
||
<div class="row">
|
||
<div class="span4">
|
||
<div class="btn-toolbar">
|
||
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
||
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
||
</div>
|
||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||
</div>
|
||
</div>
|
||
<ul class="side-nav nav nav-list">
|
||
<li class="nav-header">
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods
|
||
<ul>
|
||
<li class="method public "><a href="#method___construct" title="__construct() :: Create the object by passing the resource for
|
||
the query"><span class="description">Create the object by passing the resource for
|
||
the query</span><pre>__construct()</pre></a></li>
|
||
<li class="method public "><a href="#method_bindColumn" title="bindColumn() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindColumn()</pre></a></li>
|
||
<li class="method public "><a href="#method_bindParam" title="bindParam() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindParam()</pre></a></li>
|
||
<li class="method public "><a href="#method_bindValue" title="bindValue() :: Invalidate method for data consistency"><span class="description">Invalidate method for data consistency</span><pre>bindValue()</pre></a></li>
|
||
<li class="method public "><a href="#method_errorCode" title="errorCode() :: Method to emulate PDOStatement->errorCode"><span class="description">Method to emulate PDOStatement->errorCode</span><pre>errorCode()</pre></a></li>
|
||
<li class="method public "><a href="#method_errorInfo" title="errorInfo() :: Method to emulate PDO->errorInfo / PDOStatement->errorInfo"><span class="description">Method to emulate PDO->errorInfo / PDOStatement->errorInfo</span><pre>errorInfo()</pre></a></li>
|
||
<li class="method public "><a href="#method_execute" title="execute() :: Run a prepared statement query"><span class="description">Run a prepared statement query</span><pre>execute()</pre></a></li>
|
||
<li class="method public "><a href="#method_fetch" title="fetch() :: Emulate PDO fetch public function"><span class="description">Emulate PDO fetch public function</span><pre>fetch()</pre></a></li>
|
||
<li class="method public "><a href="#method_fetchAll" title="fetchAll() :: Emulate PDO fetchAll public function"><span class="description">Emulate PDO fetchAll public function</span><pre>fetchAll()</pre></a></li>
|
||
<li class="method public "><a href="#method_fetchColumn" title="fetchColumn() :: Emulate PDOStatement::fetchColumn"><span class="description">Emulate PDOStatement::fetchColumn</span><pre>fetchColumn()</pre></a></li>
|
||
<li class="method public "><a href="#method_fetchObject" title="fetchObject() :: Emulate PDOStatement::fetchObject, but only for the default use"><span class="description">Emulate PDOStatement::fetchObject, but only for the default use</span><pre>fetchObject()</pre></a></li>
|
||
<li class="method public "><a href="#method_rowCount" title="rowCount() :: Return the number of rows affected by the previous query"><span class="description">Return the number of rows affected by the previous query</span><pre>rowCount()</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header">
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties
|
||
<ul></ul>
|
||
</li>
|
||
<li class="nav-header private">» Private
|
||
<ul>
|
||
<li class="property private "><a href="#property_result" title="$result() :: Data pulled from query"><span class="description"></span><pre>$result</pre></a></li>
|
||
<li class="property private "><a href="#property_row" title="$row() :: Current row in result array"><span class="description"></span><pre>$row</pre></a></li>
|
||
<li class="property private "><a href="#property_statement" title="$statement() :: Reference to fbird resource"><span class="description"></span><pre>$statement</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="span8">
|
||
<a id="\Query\Driver\Firebird_Result"></a><ul class="breadcrumb">
|
||
<li>
|
||
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
|
||
</li>
|
||
<li><a href="../namespaces/Query.html">Query</a></li>
|
||
<li>
|
||
<span class="divider">\</span><a href="../namespaces/Query.Driver.html">Driver</a>
|
||
</li>
|
||
<li class="active">
|
||
<span class="divider">\</span><a href="../classes/Query.Driver.Firebird_Result.html">Firebird_Result</a>
|
||
</li>
|
||
</ul>
|
||
<div class="element class">
|
||
<p class="short_description">Firebird result class to emulate PDOStatement Class - only implements
|
||
data-fetching methods</p>
|
||
<div class="details">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>package</th>
|
||
<td><a href="../packages/Query.Drivers.html">Query</a></td>
|
||
</tr>
|
||
<tr>
|
||
<th>subpackage</th>
|
||
<td>Drivers</td>
|
||
</tr>
|
||
</table>
|
||
<h3>
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
|
||
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
|
||
<h2>Create the object by passing the resource for
|
||
the query</h2>
|
||
<pre>__construct(resource $link) </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$link</h4>
|
||
<code>resource</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_bindColumn"></a><div class="element clickable method public method_bindColumn" data-toggle="collapse" data-target=".method_bindColumn .collapse" title="public">
|
||
<h2>Invalidate method for data consistency</h2>
|
||
<pre>bindColumn(mixed $column, mixed $param, int $type<code> = NULL</code>, mixed $maxlen<code> = NULL</code>, array $driverdata<code> = NULL</code>) : NULL</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$column</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$param</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$type</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$maxlen</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$driverdata</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>NULL</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_bindParam"></a><div class="element clickable method public method_bindParam" data-toggle="collapse" data-target=".method_bindParam .collapse" title="public">
|
||
<h2>Invalidate method for data consistency</h2>
|
||
<pre>bindParam(mixed $parameter, mixed $variable, int $data_type<code> = NULL</code>, mixed $maxlen<code> = NULL</code>, array $driverdata<code> = NULL</code>) : NULL</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$parameter</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$variable</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$data_type</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$maxlen</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$driverdata</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>NULL</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_bindValue"></a><div class="element clickable method public method_bindValue" data-toggle="collapse" data-target=".method_bindValue .collapse" title="public">
|
||
<h2>Invalidate method for data consistency</h2>
|
||
<pre>bindValue(mixed $parameter, mixed $variable, int $data_type<code> = NULL</code>) : NULL</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$parameter</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$variable</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$data_type</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>NULL</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_errorCode"></a><div class="element clickable method public method_errorCode" data-toggle="collapse" data-target=".method_errorCode .collapse" title="public">
|
||
<h2>Method to emulate PDOStatement->errorCode</h2>
|
||
<pre>errorCode() : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_errorInfo"></a><div class="element clickable method public method_errorInfo" data-toggle="collapse" data-target=".method_errorInfo .collapse" title="public">
|
||
<h2>Method to emulate PDO->errorInfo / PDOStatement->errorInfo</h2>
|
||
<pre>errorInfo() : array</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_execute"></a><div class="element clickable method public method_execute" data-toggle="collapse" data-target=".method_execute .collapse" title="public">
|
||
<h2>Run a prepared statement query</h2>
|
||
<pre>execute(array $args<code> = NULL</code>) : <a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$args</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query.Driver.Firebird_Result.html">\Query\Driver\Firebird_Result</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_fetch"></a><div class="element clickable method public method_fetch" data-toggle="collapse" data-target=".method_fetch .collapse" title="public">
|
||
<h2>Emulate PDO fetch public function</h2>
|
||
<pre>fetch(int $fetch_style<code> = \PDO::FETCH_ASSOC</code>, mixed $cursor_orientation<code> = \PDO::FETCH_ORI_NEXT</code>, mixed $cursor_offset<code> = NULL</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$fetch_style</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$cursor_orientation</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$cursor_offset</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_fetchAll"></a><div class="element clickable method public method_fetchAll" data-toggle="collapse" data-target=".method_fetchAll .collapse" title="public">
|
||
<h2>Emulate PDO fetchAll public function</h2>
|
||
<pre>fetchAll(int $fetch_style<code> = \PDO::FETCH_ASSOC</code>, mixed $statement<code> = NULL</code>, mixed $ctor_args<code> = NULL</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$fetch_style</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$statement</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$ctor_args</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_fetchColumn"></a><div class="element clickable method public method_fetchColumn" data-toggle="collapse" data-target=".method_fetchColumn .collapse" title="public">
|
||
<h2>Emulate PDOStatement::fetchColumn</h2>
|
||
<pre>fetchColumn(int $column_num<code> = 0</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$column_num</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_fetchObject"></a><div class="element clickable method public method_fetchObject" data-toggle="collapse" data-target=".method_fetchObject .collapse" title="public">
|
||
<h2>Emulate PDOStatement::fetchObject, but only for the default use</h2>
|
||
<pre>fetchObject(string $class_name<code> = 'stdClass'</code>, array $ctor_args<code> = array()</code>) : <a href="stdClass.html">\Query\Driver\stdClass</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$class_name</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$ctor_args</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="stdClass.html">\Query\Driver\stdClass</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_rowCount"></a><div class="element clickable method public method_rowCount" data-toggle="collapse" data-target=".method_rowCount .collapse" title="public">
|
||
<h2>Return the number of rows affected by the previous query</h2>
|
||
<pre>rowCount() : int</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>int</code></div>
|
||
</div></div>
|
||
</div>
|
||
<h3>
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
|
||
<a id="property_result"> </a><div class="element clickable property private property_result" data-toggle="collapse" data-target=".property_result .collapse" title="private">
|
||
<h2>Data pulled from query</h2>
|
||
<pre>$result </pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>param</th>
|
||
<td></td>
|
||
</tr></table>
|
||
</div></div>
|
||
</div>
|
||
<a id="property_row"> </a><div class="element clickable property private property_row" data-toggle="collapse" data-target=".property_row .collapse" title="private">
|
||
<h2>Current row in result array</h2>
|
||
<pre>$row : int</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_statement"> </a><div class="element clickable property private property_statement" data-toggle="collapse" data-target=".property_statement .collapse" title="private">
|
||
<h2>Reference to fbird resource</h2>
|
||
<pre>$statement : resource</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="row"><footer class="span12">
|
||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
|
||
</a> and<br>
|
||
generated on 2014-04-02T17:05:03-04:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|