Query/apiDocumentation/classes/Query_ConnectionManager.html

186 lines
8.5 KiB
HTML
Raw Normal View History

2018-01-24 15:31:27 -05:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Query\ConnectionManager</title>
<link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../interfaces.html">Interfaces</a>
</li>
<li>
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../index.html">Overview</a>
</li>
<li class="separator">
<a href="../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../classes.html#Query">Query</a>
</li>
<li class="separator">ConnectionManager</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
2020-04-23 18:21:35 -04:00
<li>
<a href="#violations">Violations</a>
</li>
2018-01-24 15:31:27 -05:00
<li>
<a href="#methods">Methods</a>
</li>
<li>
2020-04-17 15:05:37 -04:00
<a href="../source/ConnectionManager.php.html#line25">Source</a>
2018-01-24 15:31:27 -05:00
</li>
</ul>
</nav>
<section>
<h1 id="introduction"><small>Query\</small>ConnectionManager</h1>
<h4>Connection manager class to manage connections for the Query method</h4>
<p/>
<ul/>
<h2 id="synopsis">Synopsis</h2>
<div class="synopsis">class ConnectionManager
{<br/><ul class="none"><li>// methods</li><li>public void <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__clone.html">__clone</a>()
</li><li>public void <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__sleep.html">__sleep</a>()
</li><li>public void <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__wakeup.html">__wakeup</a>()
</li><li>public static <span title="ConnectionManager">ConnectionManager</span> <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/getInstance.html">getInstance</a>()
</li><li>public <span title="QueryBuilderInterface">QueryBuilderInterface</span> <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/getConnection.html">getConnection</a>()
</li><li>public <span title="QueryBuilderInterface">QueryBuilderInterface</span> <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/connect.html">connect</a>()
</li><li>public array <a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/parseParams.html">parseParams</a>()
</li></ul>
}<br/></div>
2020-04-23 18:21:35 -04:00
<h2 id="violations">Violations</h2>
<div class="styled">
<h3>PHPMessDetector</h3>
<table class="styled">
<thead>
<tr>
<th>Line</th>
<th>Rule</th>
<th>Message</th>
</tr>
</thead>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">129</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">135</td>
<td>
<a href="https://phpmd.org/rules/naming.html#shortvariable" target="_blank" title="Naming Rules">ShortVariable</a>
</td>
<td>Avoid variables with short names like $db. Configured minimum length is 3.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">136</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$dsn' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">137</td>
<td>
<a href="" target="_blank" title="Clean Code Rules">UndefinedVariable</a>
</td>
<td>Avoid using undefined variables such as '$options' which will lead to PHP notices.</td>
</tr>
<tr>
<td class="line">155 - 157</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method connect uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
<tr>
<td class="line">196 - 198</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#elseexpression" target="_blank" title="Clean Code Rules">ElseExpression</a>
</td>
<td>The method parseParams uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.</td>
</tr>
</table>
</div>
2018-01-24 15:31:27 -05:00
<h2 id="methods">Methods</h2>
<div class="styled">
<h4>public</h4>
<ul>
<li id="__clone"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__clone.html">__clone()</a>
— Private clone method to prevent cloning</li>
<li id="__sleep"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__sleep.html">__sleep()</a>
— Prevent serialization of this object</li>
<li id="__wakeup"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/__wakeup.html">__wakeup()</a>
— Make sure serialize/deserialize doesn't work</li>
<li id="connect"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/connect.html">connect()</a>
— Parse the passed parameters and return a connection</li>
<li id="getConnection"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/getConnection.html">getConnection()</a>
— Returns the connection specified by the name given</li>
<li id="getInstance"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/getInstance.html">getInstance()</a>
— Return a connection manager instance</li>
<li id="parseParams"><a title="Query\ConnectionManager" href="../classes/Query_ConnectionManager/parseParams.html">parseParams()</a>
— Parses params into a dsn and option array</li>
</ul>
</div>
</section>
</div>
<footer>
2020-04-17 15:05:37 -04:00
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
2018-01-24 15:31:27 -05:00
</footer>
</body>
</html>