<h2>Usage</h2>
<h2>Constants</h2>
<h2>Properties</h2>
<h2>Methods</h2>
<div class="method">
<p><b>build</b><br />
<small>public <b>build</b>()</small><br />
<div style="margin-left:20px;"><br />
Builds the final query string<br />
return {str} <span class="caps">SQL</span> query string</p>
</div>
</div>
<div class="method">
<p><b>by<Column_Name></b><br />
<small>public <b>by<Column_Name></b>($val)</small><br />
<div style="margin-left:20px;"><br />
Magic method to add <span class="caps">WHERE</span> filters for building the final query string. Replace <Column_Name> with the name of the column to filter on. (e.g., byPost_ID for column ‘post_id’). Column type validation is enforced if enabled.<br />
param {mixed} Simple value, <span class="caps">CSV</span> or array of values to filter on</p>
</div>
</div>
<div class="method">
<p><b>from</b><br />
<small>public <b>from</b>($table)</small><br />
<div style="margin-left:20px;"><br />
Sets the table name to build a query for<br />
param {str} Table name</p>
</div>
</div>
<div class="method">
<p><b>group</b><br />
<small>public <b>group</b>($group_str)</small><br />
<div style="margin-left:20px;"><br />
Stores a <span class="caps">GROUP</span> BY clause (minus the ‘<span class="caps">GROUP</span> BY’) for building the final query string.<br />
param {str} <span class="caps">GROUP</span> BY clause</p>
</div>
</div>
<div class="method">
<p><b>limit</b><br />
<small>public <b>limit</b>($count[, $start = 0])</small><br />
<div style="margin-left:20px;"><br />
Creates and stores a <span class="caps">LIMIT</span> clause for building the final query string.<br />
param {int} Number of results to limit the result set to (must be greater than 0)<br />
param {int} Starting result set row (must be greater than or equal to 0, default value is 0)</p>
</div>
</div>
<div class="method">
<p><b>order</b><br />
<small>public <b>order</b>($order_str)</small><br />
<div style="margin-left:20px;"><br />
Stores an <span class="caps">ORDER</span> BY clause (minus the ‘<span class="caps">ORDER</span> BY’ part) for building the final query string<br />
param {str} <span class="caps">ORDER</span> BY clause</p>
</div>
</div>
<div class="method">
<p><b>querytype</b><br/>
<small>public <b>querytype</b>($type)</small><br />
<div style="margin-left:20px;"><br />
Takes in a type of query that is going to be built and verifies that it is on the approved list of query types. Since the query type determines the allowed calls and final query building logic, this should be the first call made.<br />
param {str} Type of query to run</p>
</div>
</div>
<div class="method">
<p><b>select</b><br />
<small>public <b>select</b>($fields)</small><br />
<div style="margin-left:20px;"><br />
Takes in a <span class="caps">CSV</span> string or array of database fields. (e.g., ‘field1, field2 AS bar, <acronym title="*"><span class="caps">COUNT</span></acronym> as mycount’, or array(‘field1’, ‘field2’, ‘<acronym title="*"><span class="caps">COUNT</span></acronym> AS mycount’))<br />
param {mixed} array or <span class="caps">CSV</span> of database fields</p>
</div>
</div>
<div class="method">
<p><b>set<Column_Name></b><br />
<small>public <b>set<Column_Name></b>($val)</small><br />
<div style="margin-left:20px;"><br />
Magic method to add <span class="caps">SET</span> field values for building the final query string. Replace <Column_Name> with the name of the column to set a value for on. (e.g., setPost_ID for column ‘post_id’). Column type validaiton is enforced if enabled.<br />
param {mixed} Scalar value</p>
</div>
</div>
<div class="method">
<p><b>where</b><br />
<small>public <b>where</b>($where_str)</small><br />
<div style="margin-left:20px;"><br />
Stores a raw <span class="caps">WHERE</span> clause (minus the ‘<span class="caps">WHERE</span>’) for building the final query string<br />
param {str} <span class="caps">WHERE</span> clause</p>
</div>
</div>
2008-03-27T22:33:48-07:00
6333
querybuilder
1902
QueryBuilder
2008-04-18T19:49:50-07:00
1816