Query/apiDocumentation/classes/Query_QueryBuilder/countAllResults.html

134 lines
4.1 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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::countAllResults</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">countAllResults</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>
<a href="../../source/QueryBuilder.php.html#line657">Source</a>
</li>
</ul>
</nav>
<section>
<h1><small>Query\QueryBuilder::</small>countAllResults</h1>
<h4>Retrieve the number of results for the generated query - used in place of the get() method</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function countAllResults([string
$table = '',
[boolean
$reset = TRUE]] )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$table</code>
string</dt>
<dd/>
<dt><code>$reset</code>
boolean</dt>
<dd/>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>int</dt>
<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>
<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">657</td>
<td>
<a href="https://phpmd.org/rules/cleancode.html#booleanargumentflag" target="_blank" title="Clean Code Rules">BooleanArgumentFlag</a>
</td>
<td>The method countAllResults has a boolean flag argument $reset, which is a certain sign of a Single Responsibility Principle violation.</td>
</tr>
</table>
</div>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>