Query/apiDocumentation/classes/Query_QueryBuilder/selectMin.html

142 lines
4.4 KiB
HTML
Raw Permalink 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\QueryBuilder::selectMin</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\QueryBuilder" href="../../classes/Query_QueryBuilder.html">QueryBuilder</a>
</li>
<li class="separator">selectMin</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>
<li>
2020-04-23 18:21:35 -04:00
<a href="../../source/QueryBuilder.php.html#line94">Source</a>
2018-01-24 15:31:27 -05:00
</li>
</ul>
</nav>
<section>
<h1><small>Query\QueryBuilder::</small>selectMin</h1>
<h4>Selects the minimum value of a field from a query</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function selectMin(string
$field,
[boolean
$as = FALSE] )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$field</code>
string</dt>
<dd/>
<dt><code>$as</code>
boolean</dt>
<dd><br/><br/><br/> </dd>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
2020-04-17 15:05:37 -04:00
<dt>QueryBuilder</dt>
2018-01-24 15:31:27 -05:00
<dd><br/>
</dd>
</dl>
<h2 id="interface">Defined by Interface</h2>
<p class="styled">
<code>
<a title="Query\QueryBuilderInterface" href="../../interfaces/Query_QueryBuilderInterface.html">QueryBuilderInterface</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">94</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method selectMin has a boolean flag argument $as, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
<tr>
<td class="line">94</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 $as. Configured minimum length is 3.</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>