Query/apiDocumentation/classes/Query_Drivers_AbstractDriver/driverQuery.html

135 lines
4.4 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\Drivers\AbstractDriver::driverQuery</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_Drivers">Query\Drivers</a>
</li>
<li class="separator">
<a title="Query\Drivers\AbstractDriver" href="../../classes/Query_Drivers_AbstractDriver.html">AbstractDriver</a>
</li>
<li class="separator">driverQuery</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>
<a href="#interface">Interface</a>
</li>
2019-12-11 16:09:58 -05:00
<li>
2020-04-23 18:21:35 -04:00
<a href="../../source/Drivers/AbstractDriver.php.html#line500">Source</a>
2018-01-24 15:31:27 -05:00
</li>
</ul>
</nav>
<section>
<h1><small>Query\Drivers\AbstractDriver::</small>driverQuery</h1>
<h4>Method to simplify retrieving db results for meta-data queries</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function driverQuery(<a title="Query\Drivers\string|array|null" href="../../classes/Query_Drivers_string|array|null.html">string|array|null</a>
$query,
[boolean
$filteredIndex = TRUE] )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$query</code>
object</dt>
<dd><br/><br/><br/> </dd>
<dt><code>$filteredIndex</code>
boolean</dt>
<dd><br/><br/><br/> </dd>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>array|null</dt>
<dd><br/>
</dd>
</dl>
<h2 id="interface">Defined by Interface</h2>
<p class="styled">
<code>
<a title="Query\Drivers\DriverInterface" href="../../interfaces/Query_Drivers_DriverInterface.html">DriverInterface</a>
</code>
</p>
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">500</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method driverQuery has a boolean flag argument $filteredIndex, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</div>
2018-01-24 15:31:27 -05:00
</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>