Query/docs/classes/Query.QueryBuilderInterface...

2248 lines
122 KiB
HTML
Raw Normal View History

2017-02-28 16:37:16 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>Query</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Query</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown">
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="../namespaces/Query.html">\Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">31</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">0</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2024925274"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2024925274" class="accordion-body collapse in">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-544298569"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-544298569" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1180252392"></a>
<a href="../namespaces/Query.Drivers.html" style="margin-left: 30px; padding-left: 0">Drivers</a>
</div>
<div id="namespace-1180252392" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1506678671"></a>
<a href="../namespaces/Query.Drivers.Firebird.html" style="margin-left: 30px; padding-left: 0">Firebird</a>
</div>
<div id="namespace-1506678671" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Result.html">Result</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1336765220"></a>
<a href="../namespaces/Query.Drivers.Mysql.html" style="margin-left: 30px; padding-left: 0">Mysql</a>
</div>
<div id="namespace-1336765220" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Mysql.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Mysql.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Mysql.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-313867269"></a>
<a href="../namespaces/Query.Drivers.Pgsql.html" style="margin-left: 30px; padding-left: 0">Pgsql</a>
</div>
<div id="namespace-313867269" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1078816077"></a>
<a href="../namespaces/Query.Drivers.Sqlite.html" style="margin-left: 30px; padding-left: 0">Sqlite</a>
</div>
<div id="namespace-1078816077" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.Driver.html">Driver</a></li>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Sqlite.Util.html">Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Drivers.DriverInterface.html">DriverInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.PDOInterface.html">PDOInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.PDOStatementInterface.html">PDOStatementInterface</a></li>
<li class="interface"><a href="../classes/Query.Drivers.SQLInterface.html">SQLInterface</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractDriver.html">AbstractDriver</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractSQL.html">AbstractSQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.AbstractUtil.html">AbstractUtil</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.QueryBuilderInterface.html">QueryBuilderInterface</a></li>
<li class="class"><a href="../classes/Query.AbstractQueryBuilder.html">AbstractQueryBuilder</a></li>
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
<li class="class"><a href="../classes/Query.ConnectionManager.html">ConnectionManager</a></li>
<li class="class"><a href="../classes/Query.DriverFactory.html">DriverFactory</a></li>
<li class="class"><a href="../classes/Query.QueryBuilder.html">QueryBuilder</a></li>
<li class="class"><a href="../classes/Query.QueryParser.html">QueryParser</a></li>
<li class="class"><a href="../classes/Query.State.html">State</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/Query.html">\Query</a>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\Query</small>QueryBuilderInterface</h1>
<p><em>Interface defining the Query Builder class</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span6">
<a href="#methods">Methods</a>
</section>
<section class="span6">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span6">
<a href="../classes/Query.QueryBuilderInterface.html#method_select">select()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_selectMax">selectMax()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_selectMin">selectMin()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_selectAvg">selectAvg()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_selectSum">selectSum()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_distinct">distinct()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_explain">explain()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_from">from()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_like">like()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orLike">orLike()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_notLike">notLike()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orNotLike">orNotLike()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_having">having()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orHaving">orHaving()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_where">where()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orWhere">orWhere()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_whereIn">whereIn()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orWhereIn">orWhereIn()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_whereNotIn">whereNotIn()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orWhereNotIn">orWhereNotIn()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_set">set()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_join">join()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_groupBy">groupBy()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orderBy">orderBy()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_limit">limit()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_groupStart">groupStart()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_notGroupStart">notGroupStart()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orGroupStart">orGroupStart()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_orNotGroupStart">orNotGroupStart()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_groupEnd">groupEnd()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_get">get()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_getWhere">getWhere()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_countAll">countAll()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_countAllResults">countAllResults()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_insert">insert()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_insertBatch">insertBatch()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_replace">replace()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_update">update()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_updateBatch">updateBatch()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_delete">delete()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_getCompiledSelect">getCompiledSelect()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_getCompiledInsert">getCompiledInsert()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_getCompiledUpdate">getCompiledUpdate()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_getCompiledDelete">getCompiledDelete()</a><br />
<a href="../classes/Query.QueryBuilderInterface.html#method_resetQuery">resetQuery()</a><br />
</section>
<section class="span6">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span6">
<em>No protected methods found</em>
</section>
<section class="span6">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span6">
<em>No private methods found</em>
</section>
<section class="span6">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd>
<a href="../files/Query.QueryBuilderInterface.html"><div class="path-wrapper">Query/QueryBuilderInterface.php</div></a>
</dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\Query\QueryBuilder</div></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<h2>Methods</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_select" name="method_select" class="anchor"></a>
<article class="method">
<h3 class="public ">select()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">select(string <span class="argument">$fields</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Specifies rows to select in a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$fields </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_selectMax" name="method_selectMax" class="anchor"></a>
<article class="method">
<h3 class="public ">selectMax()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">selectMax(string <span class="argument">$field</span>, string|boolean <span class="argument">$as = FALSE</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Selects the maximum value of a field from a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>string|boolean</td>
<td>$as </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_selectMin" name="method_selectMin" class="anchor"></a>
<article class="method">
<h3 class="public ">selectMin()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">selectMin(string <span class="argument">$field</span>, string|boolean <span class="argument">$as = FALSE</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Selects the minimum value of a field from a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>string|boolean</td>
<td>$as </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_selectAvg" name="method_selectAvg" class="anchor"></a>
<article class="method">
<h3 class="public ">selectAvg()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">selectAvg(string <span class="argument">$field</span>, string|boolean <span class="argument">$as = FALSE</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Selects the average value of a field from a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>string|boolean</td>
<td>$as </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_selectSum" name="method_selectSum" class="anchor"></a>
<article class="method">
<h3 class="public ">selectSum()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">selectSum(string <span class="argument">$field</span>, string|boolean <span class="argument">$as = FALSE</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Selects the sum of a field from a query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>string|boolean</td>
<td>$as </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_distinct" name="method_distinct" class="anchor"></a>
<article class="method">
<h3 class="public ">distinct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">distinct() : \Query\QueryBuilderInterface</pre>
<p><em>Adds the &#039;distinct&#039; keyword to a query</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_explain" name="method_explain" class="anchor"></a>
<article class="method">
<h3 class="public ">explain()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">explain() : \Query\QueryBuilderInterface</pre>
<p><em>Shows the query plan for the query</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_from" name="method_from" class="anchor"></a>
<article class="method">
<h3 class="public ">from()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">from(string <span class="argument">$tblname</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Specify the database table to select from</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$tblname </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_like" name="method_like" class="anchor"></a>
<article class="method">
<h3 class="public ">like()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">like(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos = &#039;both&#039;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Creates a Like clause in the sql statement</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$pos </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orLike" name="method_orLike" class="anchor"></a>
<article class="method">
<h3 class="public ">orLike()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orLike(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos = &#039;both&#039;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Generates an OR Like clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$pos </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_notLike" name="method_notLike" class="anchor"></a>
<article class="method">
<h3 class="public ">notLike()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">notLike(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos = &#039;both&#039;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Generates a NOT LIKE clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$pos </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orNotLike" name="method_orNotLike" class="anchor"></a>
<article class="method">
<h3 class="public ">orNotLike()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orNotLike(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos = &#039;both&#039;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Generates a OR NOT LIKE clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$pos </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_having" name="method_having" class="anchor"></a>
<article class="method">
<h3 class="public ">having()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">having(mixed <span class="argument">$key</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Generates a &#039;Having&#039; clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$key </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orHaving" name="method_orHaving" class="anchor"></a>
<article class="method">
<h3 class="public ">orHaving()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orHaving(mixed <span class="argument">$key</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Generates a &#039;Having&#039; clause prefixed with &#039;OR&#039;</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$key </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_where" name="method_where" class="anchor"></a>
<article class="method">
<h3 class="public ">where()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">where(mixed <span class="argument">$key</span>, mixed <span class="argument">$val = array()</span>, boolean <span class="argument">$escape = NULL</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Specify condition(s) in the where clause of a query
Note: this function works with key / value, or a
passed array with key / value pairs</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$key </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$escape </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orWhere" name="method_orWhere" class="anchor"></a>
<article class="method">
<h3 class="public ">orWhere()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orWhere(string <span class="argument">$key</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Where clause prefixed with &quot;OR&quot;</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$key </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_whereIn" name="method_whereIn" class="anchor"></a>
<article class="method">
<h3 class="public ">whereIn()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">whereIn(mixed <span class="argument">$field</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Where clause with &#039;IN&#039; statement</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orWhereIn" name="method_orWhereIn" class="anchor"></a>
<article class="method">
<h3 class="public ">orWhereIn()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orWhereIn(string <span class="argument">$field</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Where in statement prefixed with &quot;or&quot;</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_whereNotIn" name="method_whereNotIn" class="anchor"></a>
<article class="method">
<h3 class="public ">whereNotIn()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">whereNotIn(string <span class="argument">$field</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>WHERE NOT IN (FOO) clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orWhereNotIn" name="method_orWhereNotIn" class="anchor"></a>
<article class="method">
<h3 class="public ">orWhereNotIn()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orWhereNotIn(string <span class="argument">$field</span>, mixed <span class="argument">$val = array()</span>) : \Query\QueryBuilderInterface</pre>
<p><em>OR WHERE NOT IN (FOO) clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_set" name="method_set" class="anchor"></a>
<article class="method">
<h3 class="public ">set()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">set(mixed <span class="argument">$key</span>, mixed <span class="argument">$val = NULL</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Sets values for inserts / updates / deletes</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$key </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$val </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_join" name="method_join" class="anchor"></a>
<article class="method">
<h3 class="public ">join()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">join(string <span class="argument">$table</span>, string <span class="argument">$condition</span>, string <span class="argument">$type = &#039;&#039;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Creates a join phrase in a compiled query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$condition </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_groupBy" name="method_groupBy" class="anchor"></a>
<article class="method">
<h3 class="public ">groupBy()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">groupBy(mixed <span class="argument">$field</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Group the results by the selected field(s)</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>mixed</td>
<td>$field </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orderBy" name="method_orderBy" class="anchor"></a>
<article class="method">
<h3 class="public ">orderBy()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orderBy(string <span class="argument">$field</span>, string <span class="argument">$type = &quot;&quot;</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Order the results by the selected field(s)</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$field </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$type </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_limit" name="method_limit" class="anchor"></a>
<article class="method">
<h3 class="public ">limit()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">limit(integer <span class="argument">$limit</span>, integer|boolean <span class="argument">$offset = FALSE</span>) : \Query\QueryBuilderInterface</pre>
<p><em>Set a limit on the current sql statement</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$limit </td>
<td></td>
</tr>
<tr>
<td>integer|boolean</td>
<td>$offset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_groupStart" name="method_groupStart" class="anchor"></a>
<article class="method">
<h3 class="public ">groupStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">groupStart() : \Query\QueryBuilderInterface</pre>
<p><em>Adds a paren to the current query for query grouping</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_notGroupStart" name="method_notGroupStart" class="anchor"></a>
<article class="method">
<h3 class="public ">notGroupStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">notGroupStart() : \Query\QueryBuilderInterface</pre>
<p><em>Adds a paren to the current query for query grouping,
prefixed with &#039;NOT&#039;</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orGroupStart" name="method_orGroupStart" class="anchor"></a>
<article class="method">
<h3 class="public ">orGroupStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orGroupStart() : \Query\QueryBuilderInterface</pre>
<p><em>Adds a paren to the current query for query grouping,
prefixed with &#039;OR&#039;</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_orNotGroupStart" name="method_orNotGroupStart" class="anchor"></a>
<article class="method">
<h3 class="public ">orNotGroupStart()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">orNotGroupStart() : \Query\QueryBuilderInterface</pre>
<p><em>Adds a paren to the current query for query grouping,
prefixed with &#039;OR NOT&#039;</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_groupEnd" name="method_groupEnd" class="anchor"></a>
<article class="method">
<h3 class="public ">groupEnd()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">groupEnd() : \Query\QueryBuilderInterface</pre>
<p><em>Ends a query group</em></p>
<h4>Returns</h4>
<a href="../classes/Query.QueryBuilderInterface.html">\Query\QueryBuilderInterface</a>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get" name="method_get" class="anchor"></a>
<article class="method">
<h3 class="public ">get()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get(string <span class="argument">$table = &#039;&#039;</span>, integer|boolean <span class="argument">$limit = FALSE</span>, integer|boolean <span class="argument">$offset = FALSE</span>) : \PDOStatement</pre>
<p><em>Select and retrieve all records from the current table, and/or
execute current compiled query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>integer|boolean</td>
<td>$limit </td>
<td></td>
</tr>
<tr>
<td>integer|boolean</td>
<td>$offset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getWhere" name="method_getWhere" class="anchor"></a>
<article class="method">
<h3 class="public ">getWhere()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getWhere(string <span class="argument">$table</span>, array <span class="argument">$where = array()</span>, integer|boolean <span class="argument">$limit = FALSE</span>, integer|boolean <span class="argument">$offset = FALSE</span>) : \PDOStatement</pre>
<p><em>Convenience method for get() with a where clause</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$where </td>
<td></td>
</tr>
<tr>
<td>integer|boolean</td>
<td>$limit </td>
<td></td>
</tr>
<tr>
<td>integer|boolean</td>
<td>$offset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_countAll" name="method_countAll" class="anchor"></a>
<article class="method">
<h3 class="public ">countAll()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">countAll(string <span class="argument">$table</span>) : integer</pre>
<p><em>Retrieve the number of rows in the selected table</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_countAllResults" name="method_countAllResults" class="anchor"></a>
<article class="method">
<h3 class="public ">countAllResults()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">countAllResults(string <span class="argument">$table = &#039;&#039;</span>, boolean <span class="argument">$reset = TRUE</span>) : integer</pre>
<p><em>Retrieve the number of results for the generated query - used
in place of the get() method</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$reset </td>
<td><ul>
<li>Whether to keep the query after counting the results</li>
</ul></td>
</tr>
</table>
<h4>Returns</h4>
integer
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_insert" name="method_insert" class="anchor"></a>
<article class="method">
<h3 class="public ">insert()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">insert(string <span class="argument">$table</span>, mixed <span class="argument">$data = array()</span>) : \PDOStatement</pre>
<p><em>Creates an insert clause, and executes it</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_insertBatch" name="method_insertBatch" class="anchor"></a>
<article class="method">
<h3 class="public ">insertBatch()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">insertBatch(string <span class="argument">$table</span>, array <span class="argument">$data = array()</span>) : \PDOStatement|null</pre>
<p><em>Creates and executes a batch insertion query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement|null
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_replace" name="method_replace" class="anchor"></a>
<article class="method">
<h3 class="public ">replace()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">replace(string <span class="argument">$table</span>, array <span class="argument">$data = array()</span>) : \PDOStatement|null</pre>
<p><em>Insertion with automatic overwrite, rather than attempted duplication</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement|null
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_update" name="method_update" class="anchor"></a>
<article class="method">
<h3 class="public ">update()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">update(string <span class="argument">$table</span>, mixed <span class="argument">$data = array()</span>) : \PDOStatement</pre>
<p><em>Creates an update clause, and executes it</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$data </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_updateBatch" name="method_updateBatch" class="anchor"></a>
<article class="method">
<h3 class="public ">updateBatch()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">updateBatch(string <span class="argument">$table</span>, array|object <span class="argument">$data</span>, string <span class="argument">$where</span>) : integer|null</pre>
<p><em>Creates a batch update, and executes it.</em></p>
<p>Returns the number of affected rows</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>array|object</td>
<td>$data </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$where </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
integer|null
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_delete" name="method_delete" class="anchor"></a>
<article class="method">
<h3 class="public ">delete()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">delete(string <span class="argument">$table</span>, mixed <span class="argument">$where = &#039;&#039;</span>) : \PDOStatement</pre>
<p><em>Deletes data from a table</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>mixed</td>
<td>$where </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\PDOStatement
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getCompiledSelect" name="method_getCompiledSelect" class="anchor"></a>
<article class="method">
<h3 class="public ">getCompiledSelect()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getCompiledSelect(string <span class="argument">$table = &#039;&#039;</span>, boolean <span class="argument">$reset = TRUE</span>) : string</pre>
<p><em>Returns the generated &#039;select&#039; sql query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$reset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getCompiledInsert" name="method_getCompiledInsert" class="anchor"></a>
<article class="method">
<h3 class="public ">getCompiledInsert()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getCompiledInsert(string <span class="argument">$table</span>, boolean <span class="argument">$reset = TRUE</span>) : string</pre>
<p><em>Returns the generated &#039;insert&#039; sql query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$reset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getCompiledUpdate" name="method_getCompiledUpdate" class="anchor"></a>
<article class="method">
<h3 class="public ">getCompiledUpdate()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getCompiledUpdate(string <span class="argument">$table = &#039;&#039;</span>, boolean <span class="argument">$reset = TRUE</span>) : string</pre>
<p><em>Returns the generated &#039;update&#039; sql query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$reset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getCompiledDelete" name="method_getCompiledDelete" class="anchor"></a>
<article class="method">
<h3 class="public ">getCompiledDelete()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getCompiledDelete(string <span class="argument">$table = &#039;&#039;</span>, boolean <span class="argument">$reset = TRUE</span>) : string</pre>
<p><em>Returns the generated &#039;delete&#039; sql query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$table </td>
<td></td>
</tr>
<tr>
<td>boolean</td>
<td>$reset </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
string
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_resetQuery" name="method_resetQuery" class="anchor"></a>
<article class="method">
<h3 class="public ">resetQuery()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">resetQuery() : void</pre>
<p><em>Clear out the class variables, so the next query can be run</em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">QueryBuilderInterface.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/Query/QueryBuilderInterface.php.txt" class="language-php"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
<li><a href="../namespaces/Query.html">\Query</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on February 28th, 2017 at 21:36.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>