Query/docs/classes/Query.Query_Builder_Interface.html
2015-07-31 10:56:16 -04:00

2347 lines
121 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/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="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/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">0</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</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-452499101"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-452499101" 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-841801669"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-841801669" 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-1476095808"></a>
<a href="../namespaces/Query.Drivers.html" style="margin-left: 30px; padding-left: 0">Drivers</a>
</div>
<div id="namespace-1476095808" 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-1275880041"></a>
<a href="../namespaces/Query.Drivers.Sqlite.html" style="margin-left: 30px; padding-left: 0">Sqlite</a>
</div>
<div id="namespace-1275880041" 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>
<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-1307529115"></a>
<a href="../namespaces/Query.Drivers.Firebird.html" style="margin-left: 30px; padding-left: 0">Firebird</a>
</div>
<div id="namespace-1307529115" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Firebird.SQL.html">SQL</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.Util.html">Util</a></li>
<li class="class"><a href="../classes/Query.Drivers.Firebird.Driver.html">Driver</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-1444356523"></a>
<a href="../namespaces/Query.Drivers.Mysql.html" style="margin-left: 30px; padding-left: 0">Mysql</a>
</div>
<div id="namespace-1444356523" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<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>
<li class="class"><a href="../classes/Query.Drivers.Mysql.Driver.html">Driver</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-1852042683"></a>
<a href="../namespaces/Query.Drivers.Pdo_firebird.html" style="margin-left: 30px; padding-left: 0">Pdo_firebird</a>
</div>
<div id="namespace-1852042683" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Pdo_firebird.SQL.html">SQL</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pdo_firebird.Util.html">Util</a></li>
<li class="class"><a href="../classes/Query.Drivers.Pdo_firebird.Driver.html">Driver</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-2134056612"></a>
<a href="../namespaces/Query.Drivers.Pgsql.html" style="margin-left: 30px; padding-left: 0">Pgsql</a>
</div>
<div id="namespace-2134056612" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Drivers.Pgsql.Util.html">Util</a></li>
<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>
</ul>
</div>
</div>
</div>
</div>
<ul>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Query_Builder_Interface.html">Query_Builder_Interface</a></li>
<li class="interface"><a href="../classes/Query.Driver_Interface.html">Driver_Interface</a></li>
<li class="interface"><a href="../classes/Query.SQL_Interface.html">SQL_Interface</a></li>
<li class="class"><a href="../classes/Query.Abstract_Util.html">Abstract_Util</a></li>
<li class="class"><a href="../classes/Query.Abstract_SQL.html">Abstract_SQL</a></li>
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
<li class="class"><a href="../classes/Query.Query_Builder.html">Query_Builder</a></li>
<li class="class"><a href="../classes/Query.Abstract_Query_Builder.html">Abstract_Query_Builder</a></li>
<li class="class"><a href="../classes/Query.Abstract_Driver.html">Abstract_Driver</a></li>
<li class="class"><a href="../classes/Query.Connection_Manager.html">Connection_Manager</a></li>
<li class="class"><a href="../classes/Query.Query_Parser.html">Query_Parser</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>Query_Builder_Interface</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.Query_Builder_Interface.html#method_select">select()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_select_max">select_max()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_select_min">select_min()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_select_avg">select_avg()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_select_sum">select_sum()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_distinct">distinct()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_explain">explain()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_from">from()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_like">like()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_like">or_like()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_not_like">not_like()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_not_like">or_not_like()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_having">having()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_having">or_having()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_where">where()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_where">or_where()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_where_in">where_in()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_where_in">or_where_in()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_where_not_in">where_not_in()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_where_not_in">or_where_not_in()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_set">set()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_join">join()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_group_by">group_by()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_order_by">order_by()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_limit">limit()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_group_start">group_start()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_group_start">or_group_start()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_or_not_group_start">or_not_group_start()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_group_end">group_end()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get">get()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get_where">get_where()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_count_all">count_all()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_count_all_results">count_all_results()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_insert">insert()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_insert_batch">insert_batch()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_update">update()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_delete">delete()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get_compiled_select">get_compiled_select()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get_compiled_insert">get_compiled_insert()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get_compiled_update">get_compiled_update()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_get_compiled_delete">get_compiled_delete()</a><br />
<a href="../classes/Query.Query_Builder_Interface.html#method_reset_query">reset_query()</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/src.Query.Query_Builder_Interface.php.html"><div class="path-wrapper">src/Query/Query_Builder_Interface.php</div></a>
</dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\Query\Query_Builder\Query_Builder</div></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>todo</th>
<td>
</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\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_select_max" name="method_select_max" class="anchor"></a>
<article class="method">
<h3 class="public ">select_max()</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_max(string <span class="argument">$field</span>, string|bool <span class="argument">$as</span>) : \Query\Query_Builder</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|bool</td>
<td>$as</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_select_min" name="method_select_min" class="anchor"></a>
<article class="method">
<h3 class="public ">select_min()</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_min(string <span class="argument">$field</span>, string|bool <span class="argument">$as</span>) : \Query\Query_Builder</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|bool</td>
<td>$as</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_select_avg" name="method_select_avg" class="anchor"></a>
<article class="method">
<h3 class="public ">select_avg()</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_avg(string <span class="argument">$field</span>, string|bool <span class="argument">$as</span>) : \Query\Query_Builder</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|bool</td>
<td>$as</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_select_sum" name="method_select_sum" class="anchor"></a>
<article class="method">
<h3 class="public ">select_sum()</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_sum(string <span class="argument">$field</span>, string|bool <span class="argument">$as</span>) : \Query\Query_Builder</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|bool</td>
<td>$as</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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\Query_Builder</pre>
<p><em>Adds the &#039;distinct&#039; keyword to a query</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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\Query_Builder</pre>
<p><em>Shows the query plan for the query</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_like" name="method_or_like" class="anchor"></a>
<article class="method">
<h3 class="public ">or_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;">or_like(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_not_like" name="method_not_like" class="anchor"></a>
<article class="method">
<h3 class="public ">not_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;">not_like(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_not_like" name="method_or_not_like" class="anchor"></a>
<article class="method">
<h3 class="public ">or_not_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;">or_not_like(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>, string <span class="argument">$pos</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_having" name="method_or_having" class="anchor"></a>
<article class="method">
<h3 class="public ">or_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;">or_having(mixed <span class="argument">$key</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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</span>, bool <span class="argument">$escape</span>) : \Query\Query_Builder</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>bool</td>
<td>$escape</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_where" name="method_or_where" class="anchor"></a>
<article class="method">
<h3 class="public ">or_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;">or_where(string <span class="argument">$key</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_where_in" name="method_where_in" class="anchor"></a>
<article class="method">
<h3 class="public ">where_in()</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_in(mixed <span class="argument">$field</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_where_in" name="method_or_where_in" class="anchor"></a>
<article class="method">
<h3 class="public ">or_where_in()</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;">or_where_in(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_where_not_in" name="method_where_not_in" class="anchor"></a>
<article class="method">
<h3 class="public ">where_not_in()</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_not_in(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_where_not_in" name="method_or_where_not_in" class="anchor"></a>
<article class="method">
<h3 class="public ">or_where_not_in()</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;">or_where_not_in(string <span class="argument">$field</span>, mixed <span class="argument">$val</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_group_by" name="method_group_by" class="anchor"></a>
<article class="method">
<h3 class="public ">group_by()</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;">group_by(mixed <span class="argument">$field</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_order_by" name="method_order_by" class="anchor"></a>
<article class="method">
<h3 class="public ">order_by()</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;">order_by(string <span class="argument">$field</span>, string <span class="argument">$type</span>) : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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(int <span class="argument">$limit</span>, int|bool <span class="argument">$offset</span>) : \Query\Query_Builder</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>int</td>
<td>$limit</td>
<td></td>
</tr>
<tr>
<td>int|bool</td>
<td>$offset</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_group_start" name="method_group_start" class="anchor"></a>
<article class="method">
<h3 class="public ">group_start()</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;">group_start() : \Query\Query_Builder</pre>
<p><em>Adds a paren to the current query for query grouping</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_group_start" name="method_or_group_start" class="anchor"></a>
<article class="method">
<h3 class="public ">or_group_start()</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;">or_group_start() : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_or_not_group_start" name="method_or_not_group_start" class="anchor"></a>
<article class="method">
<h3 class="public ">or_not_group_start()</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;">or_not_group_start() : \Query\Query_Builder</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.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_group_end" name="method_group_end" class="anchor"></a>
<article class="method">
<h3 class="public ">group_end()</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;">group_end() : \Query\Query_Builder</pre>
<p><em>Ends a query group</em></p>
<h4>Returns</h4>
<a href="../classes/Query.Query_Builder.html">\Query\Query_Builder</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>
<th>
todo
</th>
<td>
</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(mixed <span class="argument">$table</span>, int|bool <span class="argument">$limit</span>, int|bool <span class="argument">$offset</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>mixed</td>
<td>$table</td>
<td></td>
</tr>
<tr>
<td>int|bool</td>
<td>$limit</td>
<td></td>
</tr>
<tr>
<td>int|bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_where" name="method_get_where" class="anchor"></a>
<article class="method">
<h3 class="public ">get_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;">get_where(string <span class="argument">$table</span>, array <span class="argument">$where</span>, int|bool <span class="argument">$limit</span>, int|bool <span class="argument">$offset</span>) : \PDOStatement</pre>
<p><em>Convience 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>int|bool</td>
<td>$limit</td>
<td></td>
</tr>
<tr>
<td>int|bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_count_all" name="method_count_all" class="anchor"></a>
<article class="method">
<h3 class="public ">count_all()</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;">count_all(string <span class="argument">$table</span>) : int</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>
int
</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_count_all_results" name="method_count_all_results" class="anchor"></a>
<article class="method">
<h3 class="public ">count_all_results()</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;">count_all_results(string <span class="argument">$table</span>) : int</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>
</table>
<h4>Returns</h4>
int
</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>
<th>
todo
</th>
<td>
</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</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_insert_batch" name="method_insert_batch" class="anchor"></a>
<article class="method">
<h3 class="public ">insert_batch()</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_batch(string <span class="argument">$table</span>, array <span class="argument">$data</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>
<th>
todo
</th>
<td>
</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</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>
<th>
todo
</th>
<td>
</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</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_compiled_select" name="method_get_compiled_select" class="anchor"></a>
<article class="method">
<h3 class="public ">get_compiled_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;">get_compiled_select(string <span class="argument">$table</span>, bool <span class="argument">$reset</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>bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_compiled_insert" name="method_get_compiled_insert" class="anchor"></a>
<article class="method">
<h3 class="public ">get_compiled_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;">get_compiled_insert(string <span class="argument">$table</span>, bool <span class="argument">$reset</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>bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_compiled_update" name="method_get_compiled_update" class="anchor"></a>
<article class="method">
<h3 class="public ">get_compiled_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;">get_compiled_update(string <span class="argument">$table</span>, bool <span class="argument">$reset</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>bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_compiled_delete" name="method_get_compiled_delete" class="anchor"></a>
<article class="method">
<h3 class="public ">get_compiled_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;">get_compiled_delete(string <span class="argument">$table</span>, bool <span class="argument">$reset</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>bool</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>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_reset_query" name="method_reset_query" class="anchor"></a>
<article class="method">
<h3 class="public ">reset_query()</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;">reset_query() : 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>
<th>
todo
</th>
<td>
</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">Query_Builder_Interface.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/src/Query/Query_Builder_Interface.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 July 31st, 2015 at 10:55.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>