971 lines
45 KiB
HTML
971 lines
45 KiB
HTML
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" 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/Default.html"><i class="icon-folder-open"></i> Default</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">23</span></a></li>
|
|||
|
|
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
|
|||
|
|
<ul><li>todo
|
|||
|
|
<span class="label label-info">2</span>
|
|||
|
|
</li></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">
|
|||
|
|
<span 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></span><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>
|
|||
|
|
<ul class="side-nav nav nav-list">
|
|||
|
|
<li class="nav-header">
|
|||
|
|
<i class="icon-custom icon-method"></i> Methods</li>
|
|||
|
|
<li class="method public "><a href="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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>
|
|||
|
|
</div>
|
|||
|
|
<div class="span8">
|
|||
|
|
<a name="%5CiQuery_Builder" id="\iQuery_Builder"></a><div href="../classes/iQuery_Builder.html" class="element interface">
|
|||
|
|
<p class="short_description">Interface defining the Query Builder class</p>
|
|||
|
|
<div class="details">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 class="icon-custom icon-method"></i> Methods</h3>
|
|||
|
|
<a name="count_all" id="count_all"></a><div class="element clickable method public count_all" data-toggle="collapse" data-target=".count_all .collapse">
|
|||
|
|
<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="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="count_all_results" id="count_all_results"></a><div class="element clickable method public count_all_results" data-toggle="collapse" data-target=".count_all_results .collapse">
|
|||
|
|
<h2>Retrieve the number of results for the generated query - used
|
|||
|
|
in place of the get() method</h2>
|
|||
|
|
<pre>count_all_results(string $table) : int</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="delete" id="delete"></a><div class="element clickable method public delete" data-toggle="collapse" data-target=".delete .collapse">
|
|||
|
|
<h2>Deletes data from a table</h2>
|
|||
|
|
<pre>delete(string $table, mixed $where) : mixed</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="distinct" id="distinct"></a><div class="element clickable method public distinct" data-toggle="collapse" data-target=".distinct .collapse">
|
|||
|
|
<h2>Adds the 'distinct' keyword to a query</h2>
|
|||
|
|
<pre>distinct() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="from" id="from"></a><div class="element clickable method public from" data-toggle="collapse" data-target=".from .collapse">
|
|||
|
|
<h2>Specify the database table to select from</h2>
|
|||
|
|
<pre>from(string $tblname) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
|
|||
|
|
<h2>Select and retrieve all records from the current table, and/or
|
|||
|
|
execute current compiled query</h2>
|
|||
|
|
<pre>get($table, int $limit, int $offset) : object</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="subelement argument">
|
|||
|
|
<h4>$table</h4>
|
|||
|
|
<code></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 name="get_compiled_delete" id="get_compiled_delete"></a><div class="element clickable method public get_compiled_delete" data-toggle="collapse" data-target=".get_compiled_delete .collapse">
|
|||
|
|
<h2>Returns the generated 'delete' sql query</h2>
|
|||
|
|
<pre>get_compiled_delete(string $table, bool $reset) : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="get_compiled_insert" id="get_compiled_insert"></a><div class="element clickable method public get_compiled_insert" data-toggle="collapse" data-target=".get_compiled_insert .collapse">
|
|||
|
|
<h2>Returns the generated 'insert' sql query</h2>
|
|||
|
|
<pre>get_compiled_insert(string $table, bool $reset) : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="get_compiled_select" id="get_compiled_select"></a><div class="element clickable method public get_compiled_select" data-toggle="collapse" data-target=".get_compiled_select .collapse">
|
|||
|
|
<h2>Returns the generated 'select' sql query</h2>
|
|||
|
|
<pre>get_compiled_select(string $table, bool $reset) : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="get_compiled_update" id="get_compiled_update"></a><div class="element clickable method public get_compiled_update" data-toggle="collapse" data-target=".get_compiled_update .collapse">
|
|||
|
|
<h2>Returns the generated 'update' sql query</h2>
|
|||
|
|
<pre>get_compiled_update(string $table, bool $reset) : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="get_where" id="get_where"></a><div class="element clickable method public get_where" data-toggle="collapse" data-target=".get_where .collapse">
|
|||
|
|
<h2>Convience method for get() with a where clause</h2>
|
|||
|
|
<pre>get_where(string $table, array $where, int $limit, int $offset) : object</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="group_by" id="group_by"></a><div class="element clickable method public group_by" data-toggle="collapse" data-target=".group_by .collapse">
|
|||
|
|
<h2>Group the results by the selected field(s)</h2>
|
|||
|
|
<pre>group_by(mixed $field) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="group_end" id="group_end"></a><div class="element clickable method public group_end" data-toggle="collapse" data-target=".group_end .collapse">
|
|||
|
|
<h2>Ends a query group</h2>
|
|||
|
|
<pre>group_end() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="group_start" id="group_start"></a><div class="element clickable method public group_start" data-toggle="collapse" data-target=".group_start .collapse">
|
|||
|
|
<h2>Adds a paren to the current query for query grouping</h2>
|
|||
|
|
<pre>group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="having" id="having"></a><div class="element clickable method public having" data-toggle="collapse" data-target=".having .collapse">
|
|||
|
|
<h2>Generates a 'Having' clause</h2>
|
|||
|
|
<pre>having(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="insert" id="insert"></a><div class="element clickable method public insert" data-toggle="collapse" data-target=".insert .collapse">
|
|||
|
|
<h2>Creates an insert clause, and executes it</h2>
|
|||
|
|
<pre>insert(string $table, mixed $data) : mixed</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="join" id="join"></a><div class="element clickable method public join" data-toggle="collapse" data-target=".join .collapse">
|
|||
|
|
<h2>Creates a join phrase in a compiled query</h2>
|
|||
|
|
<pre>join(string $table, string $condition, string $type) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="like" id="like"></a><div class="element clickable method public like" data-toggle="collapse" data-target=".like .collapse">
|
|||
|
|
<h2>Creates a Like clause in the sql statement</h2>
|
|||
|
|
<pre>like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="limit" id="limit"></a><div class="element clickable method public limit" data-toggle="collapse" data-target=".limit .collapse">
|
|||
|
|
<h2>Set a limit on the current sql statement</h2>
|
|||
|
|
<pre>limit(int $limit, int $offset) : string</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="not_like" id="not_like"></a><div class="element clickable method public not_like" data-toggle="collapse" data-target=".not_like .collapse">
|
|||
|
|
<h2>Generates a NOT LIKE clause</h2>
|
|||
|
|
<pre>not_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_group_start" id="or_group_start"></a><div class="element clickable method public or_group_start" data-toggle="collapse" data-target=".or_group_start .collapse">
|
|||
|
|
<h2>Adds a paren to the current query for query grouping,
|
|||
|
|
prefixed with 'OR'</h2>
|
|||
|
|
<pre>or_group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_having" id="or_having"></a><div class="element clickable method public or_having" data-toggle="collapse" data-target=".or_having .collapse">
|
|||
|
|
<h2>Generates a 'Having' clause prefixed with 'OR'</h2>
|
|||
|
|
<pre>or_having(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_like" id="or_like"></a><div class="element clickable method public or_like" data-toggle="collapse" data-target=".or_like .collapse">
|
|||
|
|
<h2>Generates an OR Like clause</h2>
|
|||
|
|
<pre>or_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_not_group_start" id="or_not_group_start"></a><div class="element clickable method public or_not_group_start" data-toggle="collapse" data-target=".or_not_group_start .collapse">
|
|||
|
|
<h2>Adds a paren to the current query for query grouping,
|
|||
|
|
prefixed with 'OR NOT'</h2>
|
|||
|
|
<pre>or_not_group_start() : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_not_like" id="or_not_like"></a><div class="element clickable method public or_not_like" data-toggle="collapse" data-target=".or_not_like .collapse">
|
|||
|
|
<h2>Generates a OR NOT LIKE clause</h2>
|
|||
|
|
<pre>or_not_like(string $field, mixed $val, string $pos) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_where" id="or_where"></a><div class="element clickable method public or_where" data-toggle="collapse" data-target=".or_where .collapse">
|
|||
|
|
<h2>Where clause prefixed with "OR"</h2>
|
|||
|
|
<pre>or_where(string $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_where_in" id="or_where_in"></a><div class="element clickable method public or_where_in" data-toggle="collapse" data-target=".or_where_in .collapse">
|
|||
|
|
<h2>Where in statement prefixed with "or"</h2>
|
|||
|
|
<pre>or_where_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="or_where_not_in" id="or_where_not_in"></a><div class="element clickable method public or_where_not_in" data-toggle="collapse" data-target=".or_where_not_in .collapse">
|
|||
|
|
<h2>OR WHERE NOT IN (FOO) clause</h2>
|
|||
|
|
<pre>or_where_not_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="order_by" id="order_by"></a><div class="element clickable method public order_by" data-toggle="collapse" data-target=".order_by .collapse">
|
|||
|
|
<h2>Order the results by the selected field(s)</h2>
|
|||
|
|
<pre>order_by(string $field, string $type) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="reset_query" id="reset_query"></a><div class="element clickable method public reset_query" data-toggle="collapse" data-target=".reset_query .collapse">
|
|||
|
|
<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="span8"><p class="long_description"></p></div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="select" id="select"></a><div class="element clickable method public select" data-toggle="collapse" data-target=".select .collapse">
|
|||
|
|
<h2>Specifies rows to select in a query</h2>
|
|||
|
|
<pre>select(string $fields) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="select_avg" id="select_avg"></a><div class="element clickable method public select_avg" data-toggle="collapse" data-target=".select_avg .collapse">
|
|||
|
|
<h2>Selects the average value of a field from a query</h2>
|
|||
|
|
<pre>select_avg(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="select_max" id="select_max"></a><div class="element clickable method public select_max" data-toggle="collapse" data-target=".select_max .collapse">
|
|||
|
|
<h2>Selects the maximum value of a field from a query</h2>
|
|||
|
|
<pre>select_max(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="select_min" id="select_min"></a><div class="element clickable method public select_min" data-toggle="collapse" data-target=".select_min .collapse">
|
|||
|
|
<h2>Selects the minimum value of a field from a query</h2>
|
|||
|
|
<pre>select_min(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="select_sum" id="select_sum"></a><div class="element clickable method public select_sum" data-toggle="collapse" data-target=".select_sum .collapse">
|
|||
|
|
<h2>Selects the sum of a field from a query</h2>
|
|||
|
|
<pre>select_sum(string $field, string $as) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
|
|||
|
|
<h2>Sets values for inserts / updates / deletes</h2>
|
|||
|
|
<pre>set(mixed $key, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="update" id="update"></a><div class="element clickable method public update" data-toggle="collapse" data-target=".update .collapse">
|
|||
|
|
<h2>Creates an update clause, and executes it</h2>
|
|||
|
|
<pre>update(string $table, mixed $data) : mixed</pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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 name="where" id="where"></a><div class="element clickable method public where" data-toggle="collapse" data-target=".where .collapse">
|
|||
|
|
<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) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="where_in" id="where_in"></a><div class="element clickable method public where_in" data-toggle="collapse" data-target=".where_in .collapse">
|
|||
|
|
<h2>Where clause with 'IN' statement</h2>
|
|||
|
|
<pre>where_in(mixed $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></code></div>
|
|||
|
|
</div></div>
|
|||
|
|
</div>
|
|||
|
|
<a name="where_not_in" id="where_not_in"></a><div class="element clickable method public where_not_in" data-toggle="collapse" data-target=".where_not_in .collapse">
|
|||
|
|
<h2>WHERE NOT IN (FOO) clause</h2>
|
|||
|
|
<pre>where_not_in(string $field, mixed $val) : <a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></pre>
|
|||
|
|
<div class="labels"></div>
|
|||
|
|
<div class="row collapse"><div class="span8">
|
|||
|
|
<p class="long_description"></p>
|
|||
|
|
<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><a href="../classes/iQuery_Builder.html">\iQuery_Builder</a></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.0.0a2</a> and<br>
|
|||
|
|
generated on 2012-12-18T16:17:00-05:00.<br></footer></div>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|