aviat
/
Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
Query/apiDocumentation/classes/Query_ConnectionManager/connect.html

181 lines
6.3 KiB
HTML
Raw Normal View History

Add updated documentation
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::connect</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">
<a title="Query\ConnectionManager" href="../../classes/Query_ConnectionManager.html">ConnectionManager</a>
</li>
<li class="separator">connect</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#parameter">Parameter</a>
</li>
<li>
<a href="#return">Return</a>
</li>
<li>
Update README and documentation
2018-01-26 09:16:13 -05:00
<a href="#throws">Throws</a>
</li>
Update docs to include dynamic methods
2019-12-11 16:09:58 -05:00
<li>
Update API Docs
2020-04-17 15:05:37 -04:00
<a href="../../source/ConnectionManager.php.html#line127">Source</a>
Add updated documentation
2018-01-24 15:31:27 -05:00
</li>
</ul>
</nav>
<section>
<h1><small>Query\ConnectionManager::</small>connect</h1>
<h4>Parse the passed parameters and return a connection</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
Update API Docs
2020-04-17 15:05:37 -04:00
<code>public function connect(<a title="Query\array|object" href="../../classes/Query_array|object.html">array|object</a>
Add updated documentation
2018-01-24 15:31:27 -05:00
$params )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$params</code>
—
Update README and documentation
2018-01-26 09:16:13 -05:00
object</dt>
Add updated documentation
2018-01-24 15:31:27 -05:00
<dd><br/><br/><br/> </dd>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>QueryBuilderInterface</dt>
<dd><br/>
</dd>
</dl>
Update README and documentation
2018-01-26 09:16:13 -05:00
<h2 id="throws">Errors/Exceptions</h2>
<dl class="styled">
<dt>
<code>
Update documentation
2018-01-26 16:27:34 -05:00
<a title="Query\Exception\BadDBDriverException" href="../../classes/Query_Exception_BadDBDriverException.html">BadDBDriverException</a>
Update README and documentation
2018-01-26 09:16:13 -05:00
</code>
</dt>
<dd/>
</dl>
Update API docs
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>
</table>
</div>
Add updated documentation
2018-01-24 15:31:27 -05:00
</section>
</div>
<footer>
Update API Docs
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>
Add updated documentation
2018-01-24 15:31:27 -05:00
</footer>
</body>
</html>