Query/docs/classes/Query.Abstract_Query_Builde...

1645 lines
83 KiB
HTML
Raw Normal View History

2014-04-24 17:08:09 -04: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="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-1973059634"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1973059634" 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-603904804"></a>
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
</div>
<div id="namespace-603904804" 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-783508095"></a>
<a href="../namespaces/Query.Table.html" style="margin-left: 30px; padding-left: 0">Table</a>
</div>
<div id="namespace-783508095" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Table.Abstract_Table.html">Abstract_Table</a></li>
<li class="class"><a href="../classes/Query.Table.Table_Builder.html">Table_Builder</a></li>
<li class="class"><a href="../classes/Query.Table.Table_Foreign_Key.html">Table_Foreign_Key</a></li>
<li class="class"><a href="../classes/Query.Table.Table_Column.html">Table_Column</a></li>
<li class="class"><a href="../classes/Query.Table.Table_Index.html">Table_Index</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-1540731903"></a>
<a href="../namespaces/Query.Driver.html" style="margin-left: 30px; padding-left: 0">Driver</a>
</div>
<div id="namespace-1540731903" 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-2110888069"></a>
<a href="../namespaces/Query.Driver.SQL.html" style="margin-left: 30px; padding-left: 0">SQL</a>
</div>
<div id="namespace-2110888069" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="interface"><a href="../classes/Query.Driver.SQL.SQL_Interface.html">SQL_Interface</a></li>
<li class="class"><a href="../classes/Query.Driver.SQL.Abstract_SQL.html">Abstract_SQL</a></li>
<li class="class"><a href="../classes/Query.Driver.SQL.PgSQL_SQL.html">PgSQL_SQL</a></li>
<li class="class"><a href="../classes/Query.Driver.SQL.MySQL_SQL.html">MySQL_SQL</a></li>
<li class="class"><a href="../classes/Query.Driver.SQL.Firebird_SQL.html">Firebird_SQL</a></li>
<li class="class"><a href="../classes/Query.Driver.SQL.SQLite_SQL.html">SQLite_SQL</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-630612927"></a>
<a href="../namespaces/Query.Driver.Util.html" style="margin-left: 30px; padding-left: 0">Util</a>
</div>
<div id="namespace-630612927" class="accordion-body collapse ">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/Query.Driver.Util.Firebird_Util.html">Firebird_Util</a></li>
<li class="class"><a href="../classes/Query.Driver.Util.MySQL_Util.html">MySQL_Util</a></li>
<li class="class"><a href="../classes/Query.Driver.Util.Abstract_Util.html">Abstract_Util</a></li>
<li class="class"><a href="../classes/Query.Driver.Util.SQLite_Util.html">SQLite_Util</a></li>
<li class="class"><a href="../classes/Query.Driver.Util.PgSQL_Util.html">PgSQL_Util</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Driver.Driver_Interface.html">Driver_Interface</a></li>
<li class="class"><a href="../classes/Query.Driver.Firebird_Result.html">Firebird_Result</a></li>
<li class="class"><a href="../classes/Query.Driver.Firebird.html">Firebird</a></li>
<li class="class"><a href="../classes/Query.Driver.Abstract_Driver.html">Abstract_Driver</a></li>
<li class="class"><a href="../classes/Query.Driver.SQLite.html">SQLite</a></li>
<li class="class"><a href="../classes/Query.Driver.PgSQL.html">PgSQL</a></li>
<li class="class"><a href="../classes/Query.Driver.MySQL.html">MySQL</a></li>
</ul>
</div>
</div>
</div>
</div>
<ul>
<li class="interface"><a href="../classes/Query.Query_Builder_Interface.html">Query_Builder_Interface</a></li>
<li class="class"><a href="../classes/Query.Query_Parser.html">Query_Parser</a></li>
<li class="class"><a href="../classes/Query.Query_Builder.html">Query_Builder</a></li>
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
<li class="class"><a href="../classes/Query.Connection_Manager.html">Connection_Manager</a></li>
<li class="class"><a href="../classes/Query.Abstract_Query_Builder.html">Abstract_Query_Builder</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> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\Query</small>Abstract_Query_Builder</h1>
<p><em>Abstract Class for internal implementation methods of the Query Builder</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/Query.Abstract_Query_Builder.html#method___call" class="">__call()</a><br />
</section>
<section class="span4">
<a href="../classes/Query.Abstract_Query_Builder.html#property_conn_name" class="">$conn_name</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_queries" class="">$queries</a><br />
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/Query.Abstract_Query_Builder.html#method__select" class="">_select()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__get_compile" class="">_get_compile()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__like" class="">_like()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__having" class="">_having()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__where" class="">_where()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__where_string" class="">_where_string()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__where_in" class="">_where_in()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__run" class="">_run()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__append_map" class="">_append_map()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__append_query" class="">_append_query()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__compile_type" class="">_compile_type()</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#method__compile" class="">_compile()</a><br />
</section>
<section class="span4">
<a href="../classes/Query.Abstract_Query_Builder.html#property_select_string" class="">$select_string</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_from_string" class="">$from_string</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_set_string" class="">$set_string</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_order_string" class="">$order_string</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_group_string" class="">$group_string</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_set_array_keys" class="">$set_array_keys</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_order_array" class="">$order_array</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_group_array" class="">$group_array</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_values" class="">$values</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_where_values" class="">$where_values</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_limit" class="">$limit</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_offset" class="">$offset</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_query_map" class="">$query_map</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_having_map" class="">$having_map</a><br />
<a href="../classes/Query.Abstract_Query_Builder.html#property_explain" class="">$explain</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<span class="label label-info">abstract</span>
<dl>
<dt>File</dt>
<dd><a href="../files/core.abstract.abstract_query_builder.php.html"><div class="path-wrapper">core/abstract/abstract_query_builder.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">\Query</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\Query\Abstract_Query_Builder</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
todo
</th>
<td>
</td>
</tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_conn_name" name="property_conn_name" class="anchor"></a>
<article class="property">
<h3 class="public ">$conn_name</h3>
<pre class="signature">$conn_name : string</pre>
<p><em>Convenience property for connection management</em></p>
<h4>Type</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="property_queries" name="property_queries" class="anchor"></a>
<article class="property">
<h3 class="public ">$queries</h3>
<pre class="signature">$queries : array</pre>
<p><em>List of queries executed</em></p>
<h4>Type</h4>
array
</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="property_select_string" name="property_select_string" class="anchor"></a>
<article class="property">
<h3 class="protected ">$select_string</h3>
<pre class="signature">$select_string : string</pre>
<p><em>Compiled &#039;select&#039; clause</em></p>
<h4>Type</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="property_from_string" name="property_from_string" class="anchor"></a>
<article class="property">
<h3 class="protected ">$from_string</h3>
<pre class="signature">$from_string : string</pre>
<p><em>Compiled &#039;from&#039; clause</em></p>
<h4>Type</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="property_set_string" name="property_set_string" class="anchor"></a>
<article class="property">
<h3 class="protected ">$set_string</h3>
<pre class="signature">$set_string : string</pre>
<p><em>Compiled arguments for insert / update</em></p>
<h4>Type</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="property_order_string" name="property_order_string" class="anchor"></a>
<article class="property">
<h3 class="protected ">$order_string</h3>
<pre class="signature">$order_string : string</pre>
<p><em>Order by clause</em></p>
<h4>Type</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="property_group_string" name="property_group_string" class="anchor"></a>
<article class="property">
<h3 class="protected ">$group_string</h3>
<pre class="signature">$group_string : string</pre>
<p><em>Group by clause</em></p>
<h4>Type</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="property_set_array_keys" name="property_set_array_keys" class="anchor"></a>
<article class="property">
<h3 class="protected ">$set_array_keys</h3>
<pre class="signature">$set_array_keys : array</pre>
<p><em>Keys for insert/update statement</em></p>
<h4>Type</h4>
array
</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="property_order_array" name="property_order_array" class="anchor"></a>
<article class="property">
<h3 class="protected ">$order_array</h3>
<pre class="signature">$order_array : array</pre>
<p><em>Key/val pairs for order by clause</em></p>
<h4>Type</h4>
array
</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="property_group_array" name="property_group_array" class="anchor"></a>
<article class="property">
<h3 class="protected ">$group_array</h3>
<pre class="signature">$group_array : array</pre>
<p><em>Key/val pairs for group by clause</em></p>
<h4>Type</h4>
array
</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="property_values" name="property_values" class="anchor"></a>
<article class="property">
<h3 class="protected ">$values</h3>
<pre class="signature">$values : array</pre>
<p><em>Values to apply to prepared statements</em></p>
<h4>Type</h4>
array
</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="property_where_values" name="property_where_values" class="anchor"></a>
<article class="property">
<h3 class="protected ">$where_values</h3>
<pre class="signature">$where_values : array</pre>
<p><em>Values to apply to where clauses in prepared statements</em></p>
<h4>Type</h4>
array
</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="property_limit" name="property_limit" class="anchor"></a>
<article class="property">
<h3 class="protected ">$limit</h3>
<pre class="signature">$limit : string</pre>
<p><em>Value for limit string</em></p>
<h4>Type</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="property_offset" name="property_offset" class="anchor"></a>
<article class="property">
<h3 class="protected ">$offset</h3>
<pre class="signature">$offset : int</pre>
<p><em>Value for offset in limit string</em></p>
<h4>Type</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="property_query_map" name="property_query_map" class="anchor"></a>
<article class="property">
<h3 class="protected ">$query_map</h3>
<pre class="signature">$query_map : array</pre>
<p><em>Query component order mapping
for complex select queries</em></p>
<p>Format:
array(</p>
<pre><code>'type' =&gt; 'where',
'conjunction' =&gt; ' AND ',
'string' =&gt; 'k=?'</code></pre>
<p>)</p>
<h4>Type</h4>
array
</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="property_having_map" name="property_having_map" class="anchor"></a>
<article class="property">
<h3 class="protected ">$having_map</h3>
<pre class="signature">$having_map : array</pre>
<p><em>Map for having clause</em></p>
<h4>Type</h4>
array
</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="property_explain" name="property_explain" class="anchor"></a>
<article class="property">
<h3 class="protected ">$explain</h3>
<pre class="signature">$explain : bool</pre>
<p><em>Whether to do only an explain on the query</em></p>
<h4>Type</h4>
bool
</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>
<a id="methods" name="methods"></a>
<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___call" name="method___call" class="anchor"></a>
<article class="method">
<h3 class="public ">__call()</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;">__call(string <span class="argument">$name</span>, array <span class="argument">$params</span>) : mixed</pre>
<p><em>Calls a function further down the inheritence chain</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name</td>
<td></td>
</tr>
<tr>
<td>array</td>
<td>$params</td>
<td></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\BadMethodCallException</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
mixed
</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" name="method__select" class="anchor"></a>
<article class="method">
<h3 class="protected ">_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">$field</span>, string|bool <span class="argument">$as</span>) : string</pre>
<p><em>Method to simplify select_ methods</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>
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_compile" name="method__get_compile" class="anchor"></a>
<article class="method">
<h3 class="protected ">_get_compile()</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_compile(string <span class="argument">$type</span>, string <span class="argument">$table</span>, bool <span class="argument">$reset</span>) : string</pre>
<p><em>Helper function for returning sql strings</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type</td>
<td></td>
</tr>
<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__like" name="method__like" class="anchor"></a>
<article class="method">
<h3 class="protected ">_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>, string <span class="argument">$like</span>, string <span class="argument">$conj</span>) : \Query\Query_Builder</pre>
<p><em>Simplify &#039;like&#039; methods</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>
<tr>
<td>string</td>
<td>$like</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$conj</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="protected ">_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>, string <span class="argument">$conj</span>) : \Query\Query_Builder</pre>
<p><em>Simplify building having clauses</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>string</td>
<td>$conj</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="protected ">_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>) : array</pre>
<p><em>Do all the repeditive stuff for where/having type methods</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>
array
</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_string" name="method__where_string" class="anchor"></a>
<article class="method">
<h3 class="protected ">_where_string()</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_string(mixed <span class="argument">$key</span>, mixed <span class="argument">$val</span>, string <span class="argument">$conj</span>) : \Query\Query_Builder</pre>
<p><em>Simplify generating where string</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>string</td>
<td>$conj</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="protected ">_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">$key</span>, mixed <span class="argument">$val</span>, string <span class="argument">$in</span>, string <span class="argument">$conj</span>) : \Query\Query_Builder</pre>
<p><em>Simplify where_in methods</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>string</td>
<td>$in</td>
<td><ul>
<li>The (not) in fragment</li>
</ul></td>
</tr>
<tr>
<td>string</td>
<td>$conj</td>
<td><ul>
<li>The where in conjunction</li>
</ul></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__run" name="method__run" class="anchor"></a>
<article class="method">
<h3 class="protected ">_run()</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;">_run(string <span class="argument">$type</span>, string <span class="argument">$table</span>, string <span class="argument">$sql</span>, array|null <span class="argument">$vals</span>) : \PDOStatement</pre>
<p><em>Executes the compiled query</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$table</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$sql</td>
<td></td>
</tr>
<tr>
<td>array|null</td>
<td>$vals</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__append_map" name="method__append_map" class="anchor"></a>
<article class="method">
<h3 class="protected ">_append_map()</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;">_append_map(string <span class="argument">$conjunction</span>, string <span class="argument">$string</span>, string <span class="argument">$type</span>) : void</pre>
<p><em>Add an additional set of mapping pairs to a internal map</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$conjunction</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$string</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$type</td>
<td></td>
</tr>
</table>
</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__append_query" name="method__append_query" class="anchor"></a>
<article class="method">
<h3 class="protected ">_append_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;">_append_query(array <span class="argument">$vals</span>, string <span class="argument">$sql</span>, string <span class="argument">$total_time</span>) : void</pre>
<p><em>Convert the prepared statement into readable sql</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$vals</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$sql</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$total_time</td>
<td></td>
</tr>
</table>
</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__compile_type" name="method__compile_type" class="anchor"></a>
<article class="method">
<h3 class="protected ">_compile_type()</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;">_compile_type(string <span class="argument">$type</span>, string <span class="argument">$table</span>) : string</pre>
<p><em>Sub-method for generating sql strings</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$table</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__compile" name="method__compile" class="anchor"></a>
<article class="method">
<h3 class="protected ">_compile()</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;">_compile(string <span class="argument">$type</span>, string <span class="argument">$table</span>) : \Query\$string</pre>
<p><em>String together the sql statements for sending to the db</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$table</td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
\Query\$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>
</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">abstract_query_builder.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/core/abstract/abstract_query_builder.php.txt" class="language-php line-numbers"></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 April 24th, 2014 at 17:07.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>