493 lines
29 KiB
HTML
493 lines
29 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
<meta charset="utf-8"/>
|
|
<title> SYSTEM - PHP Framework » \SYSTEM\DB\ResultAMQP
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
|
|
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
<![endif]-->
|
|
<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">SYSTEM - PHP Framework</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/SYSTEM.html">SYSTEM</a></li>
|
|
<li><a href="../namespaces/LIB.html">LIB</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-list-alt"></i> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</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>
|
|
|
|
|
|
<style>
|
|
.deprecated h2 {
|
|
text-decoration: line-through;
|
|
}
|
|
</style>
|
|
<div class="row">
|
|
<div class="span4">
|
|
<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 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>
|
|
|
|
<ul class="side-nav nav nav-list">
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-method"></i> Methods
|
|
<ul>
|
|
<li class="method public">
|
|
<a href="#method___construct" title="__construct :: Construct the Resultset with a database ressource">
|
|
<span class="description">Construct the Resultset with a database ressource</span><pre>__construct</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method___destruct" title="__destruct :: Close Resultset upon destruction">
|
|
<span class="description">Close Resultset upon destruction</span><pre>__destruct</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_affectedRows" title="affectedRows :: Counts the affected lines in the Resultset">
|
|
<span class="description">Counts the affected lines in the Resultset</span><pre>affectedRows</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_close" title="close :: Closes the Resultset">
|
|
<span class="description">Closes the Resultset</span><pre>close</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_count" title="count :: Counts the Lines in the Resultset">
|
|
<span class="description">Counts the Lines in the Resultset</span><pre>count</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_next" title="next :: Returns the next line in the Resultset">
|
|
<span class="description">Returns the next line in the Resultset</span><pre>next</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_seek" title="seek :: Seeks an amount of lines within the Resultset">
|
|
<span class="description">Seeks an amount of lines within the Resultset</span><pre>seek</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>ResultAMQP</h1>
|
|
<small style="display: block; text-align: right">
|
|
Extends <a href="../classes/SYSTEM.DB.Result.html">\SYSTEM\DB\Result</a>
|
|
</small>
|
|
<p class="short_description">Result Class provided by System to hold Database Query Result Ressources of AMQP Querys.</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\DB</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i 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">
|
|
<h2>Construct the Resultset with a database ressource</h2>
|
|
<pre>__construct(\SYSTEM\DB\ressource $res) </pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$res</h4>
|
|
<code>\SYSTEM\DB\ressource</code><p><p>Ressource of the Database Result-Set</p></p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method___destruct"></a>
|
|
<div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse">
|
|
<h2>Close Resultset upon destruction</h2>
|
|
<pre>__destruct() </pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_affectedRows"></a>
|
|
<div class="element clickable method public method_affectedRows inherited" data-toggle="collapse" data-target=".method_affectedRows .collapse">
|
|
<h2>Counts the affected lines in the Resultset</h2>
|
|
<pre>affectedRows() : integer</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>integer</code><p><p>Returns number of affected lines in the result</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_close"></a>
|
|
<div class="element clickable method public method_close inherited" data-toggle="collapse" data-target=".method_close .collapse">
|
|
<h2>Closes the Resultset</h2>
|
|
<pre>close() : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Returns null</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_count"></a>
|
|
<div class="element clickable method public method_count inherited" data-toggle="collapse" data-target=".method_count .collapse">
|
|
<h2>Counts the Lines in the Resultset</h2>
|
|
<pre>count() : integer</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>integer</code><p><p>Returns number of lines in the result</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_next"></a>
|
|
<div class="element clickable method public method_next inherited" data-toggle="collapse" data-target=".method_next .collapse">
|
|
<h2>Returns the next line in the Resultset</h2>
|
|
<pre>next(boolean $object = false) : array</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$object</h4>
|
|
<code>boolean</code><p><p>Determines if the result will be an object or array</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns an array(object) containing the next line</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_seek"></a>
|
|
<div class="element clickable method public method_seek inherited" data-toggle="collapse" data-target=".method_seek .collapse">
|
|
<h2>Seeks an amount of lines within the Resultset</h2>
|
|
<pre>seek(integer $row_number) : boolean</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$row_number</h4>
|
|
<code>integer</code><p><p>Lines to seek over</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_res"> </a>
|
|
<div class="element clickable property private property_res" data-toggle="collapse" data-target=".property_res .collapse">
|
|
<h2>ressource Variable to store Database Result-ressource</h2>
|
|
<pre>res : </pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Type(s)</h3>
|
|
<code></code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="property_current"> </a>
|
|
<div class="element clickable property private property_current" data-toggle="collapse" data-target=".property_current .collapse">
|
|
<h2>ressource Variable to store current Line either as array or object</h2>
|
|
<pre>current : </pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Type(s)</h3>
|
|
<code></code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\DB\ResultAMQP"></a>
|
|
<ul class="breadcrumb">
|
|
<li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
|
|
|
|
|
|
<li><span class="divider">\</span><a href="../namespaces/SYSTEM.DB.html">DB</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.DB.ResultAMQP.html">ResultAMQP</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<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 </a> and<br/>
|
|
generated on Tue, 25 Jul 2017 11:33:07 +0200.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|