578 lines
36 KiB
HTML
578 lines
36 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\ConnectionAMQP
|
|
</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 inherited">
|
|
<a href="#method___construct" title="__construct :: Connect to the DB upon Construction.">
|
|
<span class="description">Connect to the DB upon Construction.</span><pre>__construct</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method___destruct" title="__destruct :: Destruct the Database Connection upon Destruction.">
|
|
<span class="description">Destruct the Database Connection upon Destruction.</span><pre>__destruct</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_close" title="close :: Close the Database Connection.">
|
|
<span class="description">Close the Database Connection.</span><pre>close</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_commit" title="commit :: Commit a Transaction on the Database Connection">
|
|
<span class="description">Commit a Transaction on the Database Connection</span><pre>commit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_exec" title="exec :: Exec Query on Database">
|
|
<span class="description">Exec Query on Database</span><pre>exec</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_prepare" title="prepare :: Query the Connection using Prepare Statement">
|
|
<span class="description">Query the Connection using Prepare Statement</span><pre>prepare</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_query" title="query :: Query the Connection using normal Query Statement">
|
|
<span class="description">Query the Connection using normal Query Statement</span><pre>query</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_send" title="send :: Send a Message to the AMQP Server">
|
|
<span class="description">Send a Message to the AMQP Server</span><pre>send</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_trans" title="trans :: Open a Transaction on the Database Connection">
|
|
<span class="description">Open a Transaction on the Database Connection</span><pre>trans</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
<li class="method protected inherited">
|
|
<a href="#method_getPrepareValueType" title="getPrepareValueType :: Helperfunction to convert Prepared Values to SQL Type identifiers">
|
|
<span class="description">Helperfunction to convert Prepared Values to SQL Type identifiers</span><pre>getPrepareValueType</pre>
|
|
</a>
|
|
</li>
|
|
</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>ConnectionAMQP</h1>
|
|
<small style="display: block; text-align: right">
|
|
Extends <a href="../classes/SYSTEM.DB.ConnectionAbstr.html">\SYSTEM\DB\ConnectionAbstr</a>
|
|
</small>
|
|
<p class="short_description">AMQP Connection Class provided by System to connect to AMQP Services.</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 inherited" data-toggle="collapse" data-target=".method___construct .collapse">
|
|
<h2>Connect to the DB upon Construction.</h2>
|
|
<pre>__construct(\SYSTEM\DB\DBINFO $dbinfo) </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>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$dbinfo</h4>
|
|
<code>\SYSTEM\DB\DBINFO</code><p><p>Database Information Object</p></p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method___destruct"></a>
|
|
<div class="element clickable method public method___destruct inherited" data-toggle="collapse" data-target=".method___destruct .collapse">
|
|
<h2>Destruct the Database Connection upon Destruction.</h2>
|
|
<pre>__destruct() </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>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
</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>Close the Database Connection.</h2>
|
|
<pre>close() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false depending on success</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_commit"></a>
|
|
<div class="element clickable method public method_commit inherited" data-toggle="collapse" data-target=".method_commit .collapse">
|
|
<h2>Commit a Transaction on the Database Connection</h2>
|
|
<pre>commit() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false depending on success.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_exec"></a>
|
|
<div class="element clickable method public method_exec inherited" data-toggle="collapse" data-target=".method_exec .collapse">
|
|
<h2>Exec Query on Database</h2>
|
|
<pre>exec(string $query) : \SYSTEM\DB\Result</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>$query</h4>
|
|
<code>string</code><p><p>SQL string of the Statement</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code><a href="../classes/SYSTEM.DB.Result.html">\SYSTEM\DB\Result</a></code><p><p>Returns Database Query Result.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getPrepareValueType"></a>
|
|
<div class="element clickable method protected method_getPrepareValueType inherited" data-toggle="collapse" data-target=".method_getPrepareValueType .collapse">
|
|
<h2>Helperfunction to convert Prepared Values to SQL Type identifiers</h2>
|
|
<pre>getPrepareValueType(string $value) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">static</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>$value</h4>
|
|
<code>string</code><p><p>Value to be examined regarding Type</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns d,i,s or b depending on the values type.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_prepare"></a>
|
|
<div class="element clickable method public method_prepare inherited" data-toggle="collapse" data-target=".method_prepare .collapse">
|
|
<h2>Query the Connection using Prepare Statement</h2>
|
|
<pre>prepare(string $stmtName, string $stmt, array $values, string $types = null) : \SYSTEM\DB\Result</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>$stmtName</h4>
|
|
<code>string</code><p><p>Name of the Statement - espec for PostgreSQL important</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$stmt</h4>
|
|
<code>string</code><p><p>SQL string of the Statement</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$values</h4>
|
|
<code>array</code><p><p>Array of Prepare Values</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$types</h4>
|
|
<code>string</code><p><p>types sql prepare string</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code><a href="../classes/SYSTEM.DB.Result.html">\SYSTEM\DB\Result</a></code><p><p>Returns Database Query Result.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_query"></a>
|
|
<div class="element clickable method public method_query inherited" data-toggle="collapse" data-target=".method_query .collapse">
|
|
<h2>Query the Connection using normal Query Statement</h2>
|
|
<pre>query(string $query) : \SYSTEM\DB\Result</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>$query</h4>
|
|
<code>string</code><p><p>SQL string of the Statement</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code><a href="../classes/SYSTEM.DB.Result.html">\SYSTEM\DB\Result</a></code><p><p>Returns Database Query Result.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_send"></a>
|
|
<div class="element clickable method public method_send" data-toggle="collapse" data-target=".method_send .collapse">
|
|
<h2>Send a Message to the AMQP Server</h2>
|
|
<pre>send(array $msg) : null</pre>
|
|
<div class="labels">
|
|
</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>$msg</h4>
|
|
<code>array</code><p><p>Query Object</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>null</code><p><p>Retuns null or trows an Error</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_trans"></a>
|
|
<div class="element clickable method public method_trans inherited" data-toggle="collapse" data-target=".method_trans .collapse">
|
|
<h2>Open a Transaction on the Database Connection</h2>
|
|
<pre>trans() : 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">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false depending on success.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_connection"> </a>
|
|
<div class="element clickable property private property_connection" data-toggle="collapse" data-target=".property_connection .collapse">
|
|
<h2>ressource Variable to store then open Connection</h2>
|
|
<pre>connection : </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\ConnectionAMQP"></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.ConnectionAMQP.html">ConnectionAMQP</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>
|