999 lines
46 KiB
HTML
999 lines
46 KiB
HTML
<!DOCTYPE html><html lang="en">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
||
<meta charset="utf-8">
|
||
<title>Query » \iQuery_Builder</title>
|
||
<meta name="author" content="Mike van Riel">
|
||
<meta name="description" content="">
|
||
<link href="../css/template.css" rel="stylesheet" media="all">
|
||
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
|
||
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
|
||
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
|
||
<link rel="apple-touch-icon" sizes="114x114" href="../img/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"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
|
||
<li class="dropdown">
|
||
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
||
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a>Packages</a></li>
|
||
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="dropdown" id="charts-menu">
|
||
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
||
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
|
||
</li>
|
||
<li class="dropdown" id="reports-menu">
|
||
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
||
Reports <b class="caret"></b></a><ul class="dropdown-menu">
|
||
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
|
||
<span class="label label-info">0</span></a></li>
|
||
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
||
<ul></ul></a></li>
|
||
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
|
||
<span class="label label-info">0</span></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul></div>
|
||
</div></div>
|
||
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
|
||
</div>
|
||
<div id="___" class="container">
|
||
<noscript><div class="alert alert-warning">
|
||
Javascript is disabled; several features are only available
|
||
if Javascript is enabled.
|
||
</div></noscript>
|
||
<div class="row">
|
||
<div class="span4">
|
||
<div class="btn-toolbar">
|
||
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
||
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
||
</div>
|
||
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
||
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
||
</div>
|
||
</div>
|
||
<ul class="side-nav nav nav-list"><li class="nav-header">
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods
|
||
<ul>
|
||
<li class="method public "><a href="#method_count_all" title="count_all() :: Retreive the number of rows in the selected table"><span class="description">Retreive the number of rows in the selected table</span><pre>count_all()</pre></a></li>
|
||
<li class="method public "><a href="#method_count_all_results" title="count_all_results() :: Retrieve the number of results for the generated query - used
|
||
in place of the get() method"><span class="description">Retrieve the number of results for the generated query - used
|
||
in place of the get() method</span><pre>count_all_results()</pre></a></li>
|
||
<li class="method public "><a href="#method_delete" title="delete() :: Deletes data from a table"><span class="description">Deletes data from a table</span><pre>delete()</pre></a></li>
|
||
<li class="method public "><a href="#method_distinct" title="distinct() :: Adds the 'distinct' keyword to a query"><span class="description">Adds the 'distinct' keyword to a query</span><pre>distinct()</pre></a></li>
|
||
<li class="method public "><a href="#method_explain" title="explain() :: Shows the query plan for the query"><span class="description">Shows the query plan for the query</span><pre>explain()</pre></a></li>
|
||
<li class="method public "><a href="#method_from" title="from() :: Specify the database table to select from"><span class="description">Specify the database table to select from</span><pre>from()</pre></a></li>
|
||
<li class="method public "><a href="#method_get" title="get() :: Select and retrieve all records from the current table, and/or
|
||
execute current compiled query"><span class="description">Select and retrieve all records from the current table, and/or
|
||
execute current compiled query</span><pre>get()</pre></a></li>
|
||
<li class="method public "><a href="#method_get_compiled_delete" title="get_compiled_delete() :: Returns the generated 'delete' sql query"><span class="description">Returns the generated 'delete' sql query</span><pre>get_compiled_delete()</pre></a></li>
|
||
<li class="method public "><a href="#method_get_compiled_insert" title="get_compiled_insert() :: Returns the generated 'insert' sql query"><span class="description">Returns the generated 'insert' sql query</span><pre>get_compiled_insert()</pre></a></li>
|
||
<li class="method public "><a href="#method_get_compiled_select" title="get_compiled_select() :: Returns the generated 'select' sql query"><span class="description">Returns the generated 'select' sql query</span><pre>get_compiled_select()</pre></a></li>
|
||
<li class="method public "><a href="#method_get_compiled_update" title="get_compiled_update() :: Returns the generated 'update' sql query"><span class="description">Returns the generated 'update' sql query</span><pre>get_compiled_update()</pre></a></li>
|
||
<li class="method public "><a href="#method_get_where" title="get_where() :: Convience method for get() with a where clause"><span class="description">Convience method for get() with a where clause</span><pre>get_where()</pre></a></li>
|
||
<li class="method public "><a href="#method_group_by" title="group_by() :: Group the results by the selected field(s)"><span class="description">Group the results by the selected field(s)</span><pre>group_by()</pre></a></li>
|
||
<li class="method public "><a href="#method_group_end" title="group_end() :: Ends a query group"><span class="description">Ends a query group</span><pre>group_end()</pre></a></li>
|
||
<li class="method public "><a href="#method_group_start" title="group_start() :: Adds a paren to the current query for query grouping"><span class="description">Adds a paren to the current query for query grouping</span><pre>group_start()</pre></a></li>
|
||
<li class="method public "><a href="#method_having" title="having() :: Generates a 'Having' clause"><span class="description">Generates a 'Having' clause</span><pre>having()</pre></a></li>
|
||
<li class="method public "><a href="#method_insert" title="insert() :: Creates an insert clause, and executes it"><span class="description">Creates an insert clause, and executes it</span><pre>insert()</pre></a></li>
|
||
<li class="method public "><a href="#method_join" title="join() :: Creates a join phrase in a compiled query"><span class="description">Creates a join phrase in a compiled query</span><pre>join()</pre></a></li>
|
||
<li class="method public "><a href="#method_like" title="like() :: Creates a Like clause in the sql statement"><span class="description">Creates a Like clause in the sql statement</span><pre>like()</pre></a></li>
|
||
<li class="method public "><a href="#method_limit" title="limit() :: Set a limit on the current sql statement"><span class="description">Set a limit on the current sql statement</span><pre>limit()</pre></a></li>
|
||
<li class="method public "><a href="#method_not_like" title="not_like() :: Generates a NOT LIKE clause"><span class="description">Generates a NOT LIKE clause</span><pre>not_like()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_group_start" title="or_group_start() :: Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR'"><span class="description">Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR'</span><pre>or_group_start()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_having" title="or_having() :: Generates a 'Having' clause prefixed with 'OR'"><span class="description">Generates a 'Having' clause prefixed with 'OR'</span><pre>or_having()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_like" title="or_like() :: Generates an OR Like clause"><span class="description">Generates an OR Like clause</span><pre>or_like()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_not_group_start" title="or_not_group_start() :: Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR NOT'"><span class="description">Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR NOT'</span><pre>or_not_group_start()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_not_like" title="or_not_like() :: Generates a OR NOT LIKE clause"><span class="description">Generates a OR NOT LIKE clause</span><pre>or_not_like()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_where" title='or_where() :: Where clause prefixed with "OR"'><span class="description">Where clause prefixed with "OR"</span><pre>or_where()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_where_in" title='or_where_in() :: Where in statement prefixed with "or"'><span class="description">Where in statement prefixed with "or"</span><pre>or_where_in()</pre></a></li>
|
||
<li class="method public "><a href="#method_or_where_not_in" title="or_where_not_in() :: OR WHERE NOT IN (FOO) clause"><span class="description">OR WHERE NOT IN (FOO) clause</span><pre>or_where_not_in()</pre></a></li>
|
||
<li class="method public "><a href="#method_order_by" title="order_by() :: Order the results by the selected field(s)"><span class="description">Order the results by the selected field(s)</span><pre>order_by()</pre></a></li>
|
||
<li class="method public "><a href="#method_reset_query" title="reset_query() :: Clear out the class variables, so the next query can be run"><span class="description">Clear out the class variables, so the next query can be run</span><pre>reset_query()</pre></a></li>
|
||
<li class="method public "><a href="#method_select" title="select() :: Specifies rows to select in a query"><span class="description">Specifies rows to select in a query</span><pre>select()</pre></a></li>
|
||
<li class="method public "><a href="#method_select_avg" title="select_avg() :: Selects the average value of a field from a query"><span class="description">Selects the average value of a field from a query</span><pre>select_avg()</pre></a></li>
|
||
<li class="method public "><a href="#method_select_max" title="select_max() :: Selects the maximum value of a field from a query"><span class="description">Selects the maximum value of a field from a query</span><pre>select_max()</pre></a></li>
|
||
<li class="method public "><a href="#method_select_min" title="select_min() :: Selects the minimum value of a field from a query"><span class="description">Selects the minimum value of a field from a query</span><pre>select_min()</pre></a></li>
|
||
<li class="method public "><a href="#method_select_sum" title="select_sum() :: Selects the sum of a field from a query"><span class="description">Selects the sum of a field from a query</span><pre>select_sum()</pre></a></li>
|
||
<li class="method public "><a href="#method_set" title="set() :: Sets values for inserts / updates / deletes"><span class="description">Sets values for inserts / updates / deletes</span><pre>set()</pre></a></li>
|
||
<li class="method public "><a href="#method_update" title="update() :: Creates an update clause, and executes it"><span class="description">Creates an update clause, and executes it</span><pre>update()</pre></a></li>
|
||
<li class="method public "><a href="#method_where" title="where() :: 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"><span class="description">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</span><pre>where()</pre></a></li>
|
||
<li class="method public "><a href="#method_where_in" title="where_in() :: Where clause with 'IN' statement"><span class="description">Where clause with 'IN' statement</span><pre>where_in()</pre></a></li>
|
||
<li class="method public "><a href="#method_where_not_in" title="where_not_in() :: WHERE NOT IN (FOO) clause"><span class="description">WHERE NOT IN (FOO) clause</span><pre>where_not_in()</pre></a></li>
|
||
</ul>
|
||
</li></ul>
|
||
</div>
|
||
<div class="span8">
|
||
<a id="\iQuery_Builder"></a><ul class="breadcrumb">
|
||
<li>
|
||
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
|
||
</li>
|
||
<li class="active">
|
||
<span class="divider">\</span><a href="../classes/iQuery_Builder.html">iQuery_Builder</a>
|
||
</li>
|
||
</ul>
|
||
<div class="element interface">
|
||
<p class="short_description">Interface defining the Query Builder class</p>
|
||
<div class="details">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>package</th>
|
||
<td><a href="../packages/Query.Query.html">Query</a></td>
|
||
</tr>
|
||
<tr>
|
||
<th>subpackage</th>
|
||
<td>Query</td>
|
||
</tr>
|
||
</table>
|
||
<h3>
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
|
||
<a id="method_count_all"></a><div class="element clickable method public method_count_all" data-toggle="collapse" data-target=".method_count_all .collapse" title="public">
|
||
<h2>Retreive the number of rows in the selected table</h2>
|
||
<pre>count_all(string $table) : int</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>int</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_count_all_results"></a><div class="element clickable method public method_count_all_results" data-toggle="collapse" data-target=".method_count_all_results .collapse" title="public">
|
||
<h2>Retrieve the number of results for the generated query - used
|
||
in place of the get() method</h2>
|
||
<pre>count_all_results(string $table<code> = ''</code>) : int</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>int</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse" title="public">
|
||
<h2>Deletes data from a table</h2>
|
||
<pre>delete(string $table, mixed $where<code> = ''</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$where</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_distinct"></a><div class="element clickable method public method_distinct" data-toggle="collapse" data-target=".method_distinct .collapse" title="public">
|
||
<h2>Adds the 'distinct' keyword to a query</h2>
|
||
<pre>distinct() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_explain"></a><div class="element clickable method public method_explain" data-toggle="collapse" data-target=".method_explain .collapse" title="public">
|
||
<h2>Shows the query plan for the query</h2>
|
||
<pre>explain() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_from"></a><div class="element clickable method public method_from" data-toggle="collapse" data-target=".method_from .collapse" title="public">
|
||
<h2>Specify the database table to select from</h2>
|
||
<pre>from(string $tblname) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$tblname</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get"></a><div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse" title="public">
|
||
<h2>Select and retrieve all records from the current table, and/or
|
||
execute current compiled query</h2>
|
||
<pre>get(mixed $table<code> = ''</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument"><h4>$table</h4></div>
|
||
<div class="subelement argument">
|
||
<h4>$limit</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$offset</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>object</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get_compiled_delete"></a><div class="element clickable method public method_get_compiled_delete" data-toggle="collapse" data-target=".method_get_compiled_delete .collapse" title="public">
|
||
<h2>Returns the generated 'delete' sql query</h2>
|
||
<pre>get_compiled_delete(string $table<code> = ""</code>, bool $reset<code> = TRUE</code>) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$reset</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get_compiled_insert"></a><div class="element clickable method public method_get_compiled_insert" data-toggle="collapse" data-target=".method_get_compiled_insert .collapse" title="public">
|
||
<h2>Returns the generated 'insert' sql query</h2>
|
||
<pre>get_compiled_insert(string $table, bool $reset<code> = TRUE</code>) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$reset</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get_compiled_select"></a><div class="element clickable method public method_get_compiled_select" data-toggle="collapse" data-target=".method_get_compiled_select .collapse" title="public">
|
||
<h2>Returns the generated 'select' sql query</h2>
|
||
<pre>get_compiled_select(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$reset</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get_compiled_update"></a><div class="element clickable method public method_get_compiled_update" data-toggle="collapse" data-target=".method_get_compiled_update .collapse" title="public">
|
||
<h2>Returns the generated 'update' sql query</h2>
|
||
<pre>get_compiled_update(string $table<code> = ''</code>, bool $reset<code> = TRUE</code>) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$reset</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_get_where"></a><div class="element clickable method public method_get_where" data-toggle="collapse" data-target=".method_get_where .collapse" title="public">
|
||
<h2>Convience method for get() with a where clause</h2>
|
||
<pre>get_where(string $table, array $where<code> = array()</code>, int $limit<code> = FALSE</code>, int $offset<code> = FALSE</code>) : object</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$where</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$limit</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$offset</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>object</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_group_by"></a><div class="element clickable method public method_group_by" data-toggle="collapse" data-target=".method_group_by .collapse" title="public">
|
||
<h2>Group the results by the selected field(s)</h2>
|
||
<pre>group_by(mixed $field) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_group_end"></a><div class="element clickable method public method_group_end" data-toggle="collapse" data-target=".method_group_end .collapse" title="public">
|
||
<h2>Ends a query group</h2>
|
||
<pre>group_end() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_group_start"></a><div class="element clickable method public method_group_start" data-toggle="collapse" data-target=".method_group_start .collapse" title="public">
|
||
<h2>Adds a paren to the current query for query grouping</h2>
|
||
<pre>group_start() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_having"></a><div class="element clickable method public method_having" data-toggle="collapse" data-target=".method_having .collapse" title="public">
|
||
<h2>Generates a 'Having' clause</h2>
|
||
<pre>having(mixed $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_insert"></a><div class="element clickable method public method_insert" data-toggle="collapse" data-target=".method_insert .collapse" title="public">
|
||
<h2>Creates an insert clause, and executes it</h2>
|
||
<pre>insert(string $table, mixed $data<code> = array()</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$data</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_join"></a><div class="element clickable method public method_join" data-toggle="collapse" data-target=".method_join .collapse" title="public">
|
||
<h2>Creates a join phrase in a compiled query</h2>
|
||
<pre>join(string $table, string $condition, string $type<code> = ''</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$condition</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_like"></a><div class="element clickable method public method_like" data-toggle="collapse" data-target=".method_like .collapse" title="public">
|
||
<h2>Creates a Like clause in the sql statement</h2>
|
||
<pre>like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$pos</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_limit"></a><div class="element clickable method public method_limit" data-toggle="collapse" data-target=".method_limit .collapse" title="public">
|
||
<h2>Set a limit on the current sql statement</h2>
|
||
<pre>limit(int $limit, int $offset<code> = FALSE</code>) : string</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$limit</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$offset</h4>
|
||
<code>int</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_not_like"></a><div class="element clickable method public method_not_like" data-toggle="collapse" data-target=".method_not_like .collapse" title="public">
|
||
<h2>Generates a NOT LIKE clause</h2>
|
||
<pre>not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$pos</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_group_start"></a><div class="element clickable method public method_or_group_start" data-toggle="collapse" data-target=".method_or_group_start .collapse" title="public">
|
||
<h2>Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR'</h2>
|
||
<pre>or_group_start() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_having"></a><div class="element clickable method public method_or_having" data-toggle="collapse" data-target=".method_or_having .collapse" title="public">
|
||
<h2>Generates a 'Having' clause prefixed with 'OR'</h2>
|
||
<pre>or_having(mixed $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_like"></a><div class="element clickable method public method_or_like" data-toggle="collapse" data-target=".method_or_like .collapse" title="public">
|
||
<h2>Generates an OR Like clause</h2>
|
||
<pre>or_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$pos</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_not_group_start"></a><div class="element clickable method public method_or_not_group_start" data-toggle="collapse" data-target=".method_or_not_group_start .collapse" title="public">
|
||
<h2>Adds a paren to the current query for query grouping,
|
||
prefixed with 'OR NOT'</h2>
|
||
<pre>or_not_group_start() : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_not_like"></a><div class="element clickable method public method_or_not_like" data-toggle="collapse" data-target=".method_or_not_like .collapse" title="public">
|
||
<h2>Generates a OR NOT LIKE clause</h2>
|
||
<pre>or_not_like(string $field, mixed $val, string $pos<code> = 'both'</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$pos</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_where"></a><div class="element clickable method public method_or_where" data-toggle="collapse" data-target=".method_or_where .collapse" title="public">
|
||
<h2>Where clause prefixed with "OR"</h2>
|
||
<pre>or_where(string $key, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$key</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_where_in"></a><div class="element clickable method public method_or_where_in" data-toggle="collapse" data-target=".method_or_where_in .collapse" title="public">
|
||
<h2>Where in statement prefixed with "or"</h2>
|
||
<pre>or_where_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_or_where_not_in"></a><div class="element clickable method public method_or_where_not_in" data-toggle="collapse" data-target=".method_or_where_not_in .collapse" title="public">
|
||
<h2>OR WHERE NOT IN (FOO) clause</h2>
|
||
<pre>or_where_not_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_order_by"></a><div class="element clickable method public method_order_by" data-toggle="collapse" data-target=".method_order_by .collapse" title="public">
|
||
<h2>Order the results by the selected field(s)</h2>
|
||
<pre>order_by(string $field, string $type<code> = ""</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_reset_query"></a><div class="element clickable method public method_reset_query" data-toggle="collapse" data-target=".method_reset_query .collapse" title="public">
|
||
<h2>Clear out the class variables, so the next query can be run</h2>
|
||
<pre>reset_query() : void</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="method_select"></a><div class="element clickable method public method_select" data-toggle="collapse" data-target=".method_select .collapse" title="public">
|
||
<h2>Specifies rows to select in a query</h2>
|
||
<pre>select(string $fields) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$fields</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_select_avg"></a><div class="element clickable method public method_select_avg" data-toggle="collapse" data-target=".method_select_avg .collapse" title="public">
|
||
<h2>Selects the average value of a field from a query</h2>
|
||
<pre>select_avg(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$as</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_select_max"></a><div class="element clickable method public method_select_max" data-toggle="collapse" data-target=".method_select_max .collapse" title="public">
|
||
<h2>Selects the maximum value of a field from a query</h2>
|
||
<pre>select_max(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$as</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_select_min"></a><div class="element clickable method public method_select_min" data-toggle="collapse" data-target=".method_select_min .collapse" title="public">
|
||
<h2>Selects the minimum value of a field from a query</h2>
|
||
<pre>select_min(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$as</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_select_sum"></a><div class="element clickable method public method_select_sum" data-toggle="collapse" data-target=".method_select_sum .collapse" title="public">
|
||
<h2>Selects the sum of a field from a query</h2>
|
||
<pre>select_sum(string $field, string $as<code> = FALSE</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$as</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_set"></a><div class="element clickable method public method_set" data-toggle="collapse" data-target=".method_set .collapse" title="public">
|
||
<h2>Sets values for inserts / updates / deletes</h2>
|
||
<pre>set(mixed $key, mixed $val<code> = NULL</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_update"></a><div class="element clickable method public method_update" data-toggle="collapse" data-target=".method_update .collapse" title="public">
|
||
<h2>Creates an update clause, and executes it</h2>
|
||
<pre>update(string $table, mixed $data<code> = array()</code>) : mixed</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$data</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_where"></a><div class="element clickable method public method_where" data-toggle="collapse" data-target=".method_where .collapse" title="public">
|
||
<h2>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</h2>
|
||
<pre>where(mixed $key, mixed $val<code> = array()</code>, bool $escape<code> = NULL</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$escape</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_where_in"></a><div class="element clickable method public method_where_in" data-toggle="collapse" data-target=".method_where_in .collapse" title="public">
|
||
<h2>Where clause with 'IN' statement</h2>
|
||
<pre>where_in(mixed $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_where_not_in"></a><div class="element clickable method public method_where_not_in" data-toggle="collapse" data-target=".method_where_not_in .collapse" title="public">
|
||
<h2>WHERE NOT IN (FOO) clause</h2>
|
||
<pre>where_not_in(string $field, mixed $val<code> = array()</code>) : \iQuery_Builder</pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered"><tr>
|
||
<th>fluent</th>
|
||
<td>This method is part of a fluent interface and will return the same instance</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$field</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>\iQuery_Builder</code></div>
|
||
</div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="row"><footer class="span12">
|
||
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
|
||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
|
||
</a> and<br>
|
||
generated on 2014-02-18T15:42:57-05:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|