1458 lines
74 KiB
HTML
1458 lines
74 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 » \Query_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___call" title="__call() :: Calls a function further down the inheritence chain"><span class="description">Calls a function further down the inheritence chain</span><pre>__call()</pre></a></li>
|
||
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li>
|
||
<li class="method public "><a href="#method___destruct" title="__destruct() :: Destructor"><span class="description">Destructor</span><pre>__destruct()</pre></a></li>
|
||
<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() :: Tell the database to give you the query plan instead of result set"><span class="description">Tell the database to give you the query plan instead of result set</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_insert_batch" title="insert_batch() :: Creates and executes a batch insertion query"><span class="description">Creates and executes a batch insertion query</span><pre>insert_batch()</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>
|
||
<li class="nav-header protected">» Protected
|
||
<ul>
|
||
<li class="method protected "><a href="#method__compile" title="_compile() :: String together the sql statements for sending to the db"><span class="description">String together the sql statements for sending to the db</span><pre>_compile()</pre></a></li>
|
||
<li class="method protected "><a href="#method__compile_type" title="_compile_type() :: Sub-method for generating sql strings"><span class="description">Sub-method for generating sql strings</span><pre>_compile_type()</pre></a></li>
|
||
<li class="method protected "><a href="#method__get_compile" title="_get_compile() :: Helper function for returning sql strings"><span class="description">Helper function for returning sql strings</span><pre>_get_compile()</pre></a></li>
|
||
<li class="method protected "><a href="#method__having" title="_having() :: Simplify building having clauses"><span class="description">Simplify building having clauses</span><pre>_having()</pre></a></li>
|
||
<li class="method protected "><a href="#method__like" title="_like() :: Simplify 'like' methods"><span class="description">Simplify 'like' methods</span><pre>_like()</pre></a></li>
|
||
<li class="method protected "><a href="#method__run" title="_run() :: Executes the compiled query"><span class="description">Executes the compiled query</span><pre>_run()</pre></a></li>
|
||
<li class="method protected "><a href="#method__select" title="_select() :: Method to simplify select_ methods"><span class="description">Method to simplify select_ methods</span><pre>_select()</pre></a></li>
|
||
<li class="method protected "><a href="#method__where" title="_where() :: Do all the repeditive stuff for where/having type methods"><span class="description">Do all the repeditive stuff for where/having type methods</span><pre>_where()</pre></a></li>
|
||
<li class="method protected "><a href="#method__where_in" title="_where_in() :: Simplify where_in methods"><span class="description">Simplify where_in methods</span><pre>_where_in()</pre></a></li>
|
||
<li class="method protected "><a href="#method__where_string" title="_where_string() :: Simplify generating where string"><span class="description">Simplify generating where string</span><pre>_where_string()</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header">
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties
|
||
<ul>
|
||
<li class="property public "><a href="#property_conn_name" title="$conn_name() :: Convenience property for connection management"><span class="description"></span><pre>$conn_name</pre></a></li>
|
||
<li class="property public "><a href="#property_db" title="$db() :: The current database driver"><span class="description"></span><pre>$db</pre></a></li>
|
||
<li class="property public "><a href="#property_queries" title="$queries() :: List of queries executed"><span class="description"></span><pre>$queries</pre></a></li>
|
||
<li class="property public "><a href="#property_sql" title="$sql() :: Alias to $this->db->sql"><span class="description"></span><pre>$sql</pre></a></li>
|
||
<li class="property public "><a href="#property_util" title="$util() :: Alias to $this->db->util"><span class="description"></span><pre>$util</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-header protected">» Protected
|
||
<ul>
|
||
<li class="property protected "><a href="#property_explain" title="$explain() :: Whether to do only an explain on the query"><span class="description"></span><pre>$explain</pre></a></li>
|
||
<li class="property protected "><a href="#property_from_string" title="$from_string() :: Compiled 'from' clause"><span class="description"></span><pre>$from_string</pre></a></li>
|
||
<li class="property protected "><a href="#property_group_array" title="$group_array() :: Key/val pairs for group by clause"><span class="description"></span><pre>$group_array</pre></a></li>
|
||
<li class="property protected "><a href="#property_group_string" title="$group_string() :: Group by clause"><span class="description"></span><pre>$group_string</pre></a></li>
|
||
<li class="property protected "><a href="#property_having_map" title="$having_map() :: Map for having clause"><span class="description"></span><pre>$having_map</pre></a></li>
|
||
<li class="property protected "><a href="#property_limit" title="$limit() :: Value for limit string"><span class="description"></span><pre>$limit</pre></a></li>
|
||
<li class="property protected "><a href="#property_offset" title="$offset() :: Value for offset in limit string"><span class="description"></span><pre>$offset</pre></a></li>
|
||
<li class="property protected "><a href="#property_order_array" title="$order_array() :: Key/val pairs for order by clause"><span class="description"></span><pre>$order_array</pre></a></li>
|
||
<li class="property protected "><a href="#property_order_string" title="$order_string() :: Order by clause"><span class="description"></span><pre>$order_string</pre></a></li>
|
||
<li class="property protected "><a href="#property_parser" title="$parser() :: Query parser class instance"><span class="description"></span><pre>$parser</pre></a></li>
|
||
<li class="property protected "><a href="#property_query_map" title="$query_map() :: Query component order mapping
|
||
for complex select queries"><span class="description"></span><pre>$query_map</pre></a></li>
|
||
<li class="property protected "><a href="#property_select_string" title="$select_string() :: Compiled 'select' clause"><span class="description"></span><pre>$select_string</pre></a></li>
|
||
<li class="property protected "><a href="#property_set_array_keys" title="$set_array_keys() :: Keys for insert/update statement"><span class="description"></span><pre>$set_array_keys</pre></a></li>
|
||
<li class="property protected "><a href="#property_set_string" title="$set_string() :: Compiled arguments for insert / update"><span class="description"></span><pre>$set_string</pre></a></li>
|
||
<li class="property protected "><a href="#property_values" title="$values() :: Values to apply to prepared statements"><span class="description"></span><pre>$values</pre></a></li>
|
||
<li class="property protected "><a href="#property_where_values" title="$where_values() :: Values to apply to where clauses in prepared statements"><span class="description"></span><pre>$where_values</pre></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="span8">
|
||
<a id="\Query_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/Query_Builder.html">Query_Builder</a>
|
||
</li>
|
||
</ul>
|
||
<div class="element class">
|
||
<p class="short_description">Convienience class for creating sql queries - also the class that
|
||
instantiates the specific db driver</p>
|
||
<div class="details">
|
||
<div class="long_description"></div>
|
||
<table class="table table-bordered">
|
||
<tr>
|
||
<th>package</th>
|
||
<td><a href="../packages/Query.Query_Builder.html">Query</a></td>
|
||
</tr>
|
||
<tr>
|
||
<th>subpackage</th>
|
||
<td>Query_Builder</td>
|
||
</tr>
|
||
</table>
|
||
<h3>
|
||
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
|
||
<a id="method___call"></a><div class="element clickable method public method___call" data-toggle="collapse" data-target=".method___call .collapse" title="public">
|
||
<h2>Calls a function further down the inheritence chain</h2>
|
||
<pre>__call(string $name, array $params) : 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>$name</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$params</h4>
|
||
<code>array</code>
|
||
</div>
|
||
<h3>Exceptions</h3>
|
||
<table class="table table-bordered"><tr>
|
||
<th><code><a href="BadMethodCallException.html">\BadMethodCallException</a></code></th>
|
||
<td></td>
|
||
</tr></table>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code>mixed</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
|
||
<h2>Constructor</h2>
|
||
<pre>__construct(\Abstract_driver $db, object $params) </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>$db</h4>
|
||
<code><a href="Abstract_driver.html">\Abstract_driver</a></code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$params</h4>
|
||
<code>object</code><ul>
|
||
<li>the connection parameters</li>
|
||
</ul></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method___destruct"></a><div class="element clickable method public method___destruct" data-toggle="collapse" data-target=".method___destruct .collapse" title="public">
|
||
<h2>Destructor</h2>
|
||
<pre>__destruct() </pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<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>) : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></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() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>Tell the database to give you the query plan instead of result set</h2>
|
||
<pre>explain() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$tblname</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></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>) : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></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) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$field</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method_insert_batch"></a><div class="element clickable method public method_insert_batch" data-toggle="collapse" data-target=".method_insert_batch .collapse" title="public">
|
||
<h2>Creates and executes a batch insertion query</h2>
|
||
<pre>insert_batch(string $table, array $data<code> = array()</code>) : <a href="PDOStatement.html">\PDOStatement</a></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>array</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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() : <a href="../classes/Query_Builder.html">\Query_Builder</a></pre>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<div class="long_description"></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$fields</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="PDOStatement.html">\PDOStatement</a></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><a href="PDOStatement.html">\PDOStatement</a></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>, mixed $escape<code> = NULL</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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>mixed</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></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>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__compile"></a><div class="element clickable method protected method__compile" data-toggle="collapse" data-target=".method__compile .collapse" title="protected">
|
||
<h2>String together the sql statements for sending to the db</h2>
|
||
<pre>_compile(string $type<code> = ''</code>, string $table<code> = ''</code>) : <a href="%24string.html">\$string</a></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>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="%24string.html">\$string</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__compile_type"></a><div class="element clickable method protected method__compile_type" data-toggle="collapse" data-target=".method__compile_type .collapse" title="protected">
|
||
<h2>Sub-method for generating sql strings</h2>
|
||
<pre>_compile_type(string $type<code> = ''</code>, string $table<code> = ''</code>) : <a href="%24string.html">\$string</a></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>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="%24string.html">\$string</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__get_compile"></a><div class="element clickable method protected method__get_compile" data-toggle="collapse" data-target=".method__get_compile .collapse" title="protected">
|
||
<h2>Helper function for returning sql strings</h2>
|
||
<pre>_get_compile(string $type, string $table, bool $reset) </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>resturn</th>
|
||
<td>string</td>
|
||
</tr></table>
|
||
<h3>Parameters</h3>
|
||
<div class="subelement argument">
|
||
<h4>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$reset</h4>
|
||
<code>bool</code>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__having"></a><div class="element clickable method protected method__having" data-toggle="collapse" data-target=".method__having .collapse" title="protected">
|
||
<h2>Simplify building having clauses</h2>
|
||
<pre>_having(mixed $key, mixed $val<code> = array()</code>, string $conj<code> = 'AND'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$conj</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__like"></a><div class="element clickable method protected method__like" data-toggle="collapse" data-target=".method__like .collapse" title="protected">
|
||
<h2>Simplify 'like' methods</h2>
|
||
<pre>_like(string $field, mixed $val, string $pos, string $like<code> = 'LIKE'</code>, string $conj<code> = 'AND'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$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>
|
||
<div class="subelement argument">
|
||
<h4>$like</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$conj</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__run"></a><div class="element clickable method protected method__run" data-toggle="collapse" data-target=".method__run .collapse" title="protected">
|
||
<h2>Executes the compiled query</h2>
|
||
<pre>_run(string $type, string $table, string $sql<code> = NULL</code>, array|null $vals<code> = NULL</code>) : <a href="PDOStatement.html">\PDOStatement</a></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>$type</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$table</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$sql</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$vals</h4>
|
||
<code>array</code><code>null</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="PDOStatement.html">\PDOStatement</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__select"></a><div class="element clickable method protected method__select" data-toggle="collapse" data-target=".method__select .collapse" title="protected">
|
||
<h2>Method to simplify select_ methods</h2>
|
||
<pre>_select(string $field, string $as<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>$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>string</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__where"></a><div class="element clickable method protected method__where" data-toggle="collapse" data-target=".method__where .collapse" title="protected">
|
||
<h2>Do all the repeditive stuff for where/having type methods</h2>
|
||
<pre>_where(mixed $key, mixed $val<code> = array()</code>) : array</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>$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>array</code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__where_in"></a><div class="element clickable method protected method__where_in" data-toggle="collapse" data-target=".method__where_in .collapse" title="protected">
|
||
<h2>Simplify where_in methods</h2>
|
||
<pre>_where_in(mixed $key, mixed $val<code> = array()</code>, string $in<code> = 'IN'</code>, string $conj<code> = 'AND'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$in</h4>
|
||
<code>string</code><ul>
|
||
<li>The (not) in fragment</li>
|
||
</ul></div>
|
||
<div class="subelement argument">
|
||
<h4>$conj</h4>
|
||
<code>string</code><ul>
|
||
<li>The where in conjunction</li>
|
||
</ul></div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<a id="method__where_string"></a><div class="element clickable method protected method__where_string" data-toggle="collapse" data-target=".method__where_string .collapse" title="protected">
|
||
<h2>Simplify generating where string</h2>
|
||
<pre>_where_string(mixed $key, mixed $val<code> = array()</code>, string $conj<code> = 'AND'</code>) : <a href="../classes/Query_Builder.html">\Query_Builder</a></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>$key</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$val</h4>
|
||
<code>mixed</code>
|
||
</div>
|
||
<div class="subelement argument">
|
||
<h4>$conj</h4>
|
||
<code>string</code>
|
||
</div>
|
||
<h3>Returns</h3>
|
||
<div class="subelement response"><code><a href="../classes/Query_Builder.html">\Query_Builder</a></code></div>
|
||
</div></div>
|
||
</div>
|
||
<h3>
|
||
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
|
||
<a id="property_conn_name"> </a><div class="element clickable property public property_conn_name" data-toggle="collapse" data-target=".property_conn_name .collapse" title="public">
|
||
<h2>Convenience property for connection management</h2>
|
||
<pre>$conn_name : string</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>""</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_db"> </a><div class="element clickable property public property_db" data-toggle="collapse" data-target=".property_db .collapse" title="public">
|
||
<h2>The current database driver</h2>
|
||
<pre>$db : <a href="../classes/Driver_Interface.html">\Driver_Interface</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_queries"> </a><div class="element clickable property public property_queries" data-toggle="collapse" data-target=".property_queries .collapse" title="public">
|
||
<h2>List of queries executed</h2>
|
||
<pre>$queries : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_sql"> </a><div class="element clickable property public property_sql" data-toggle="collapse" data-target=".property_sql .collapse" title="public">
|
||
<h2>Alias to $this->db->sql</h2>
|
||
<pre>$sql : <a href="../classes/SQL_Interface.html">\SQL_Interface</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_util"> </a><div class="element clickable property public property_util" data-toggle="collapse" data-target=".property_util .collapse" title="public">
|
||
<h2>Alias to $this->db->util</h2>
|
||
<pre>$util : <a href="../classes/DB_Util.html">\DB_Util</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_explain"> </a><div class="element clickable property protected property_explain" data-toggle="collapse" data-target=".property_explain .collapse" title="protected">
|
||
<h2>Whether to do only an explain on the query</h2>
|
||
<pre>$explain : bool</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_from_string"> </a><div class="element clickable property protected property_from_string" data-toggle="collapse" data-target=".property_from_string .collapse" title="protected">
|
||
<h2>Compiled 'from' clause</h2>
|
||
<pre>$from_string : <a href="type.html">\type</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_group_array"> </a><div class="element clickable property protected property_group_array" data-toggle="collapse" data-target=".property_group_array .collapse" title="protected">
|
||
<h2>Key/val pairs for group by clause</h2>
|
||
<pre>$group_array : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_group_string"> </a><div class="element clickable property protected property_group_string" data-toggle="collapse" data-target=".property_group_string .collapse" title="protected">
|
||
<h2>Group by clause</h2>
|
||
<pre>$group_string : string</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_having_map"> </a><div class="element clickable property protected property_having_map" data-toggle="collapse" data-target=".property_having_map .collapse" title="protected">
|
||
<h2>Map for having clause</h2>
|
||
<pre>$having_map : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_limit"> </a><div class="element clickable property protected property_limit" data-toggle="collapse" data-target=".property_limit .collapse" title="protected">
|
||
<h2>Value for limit string</h2>
|
||
<pre>$limit : <a href="type.html">\type</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_offset"> </a><div class="element clickable property protected property_offset" data-toggle="collapse" data-target=".property_offset .collapse" title="protected">
|
||
<h2>Value for offset in limit string</h2>
|
||
<pre>$offset : int</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_order_array"> </a><div class="element clickable property protected property_order_array" data-toggle="collapse" data-target=".property_order_array .collapse" title="protected">
|
||
<h2>Key/val pairs for order by clause</h2>
|
||
<pre>$order_array : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_order_string"> </a><div class="element clickable property protected property_order_string" data-toggle="collapse" data-target=".property_order_string .collapse" title="protected">
|
||
<h2>Order by clause</h2>
|
||
<pre>$order_string : string</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_parser"> </a><div class="element clickable property protected property_parser" data-toggle="collapse" data-target=".property_parser .collapse" title="protected">
|
||
<h2>Query parser class instance</h2>
|
||
<pre>$parser : <a href="../classes/Query_Parser.html">\Query_Parser</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_query_map"> </a><div class="element clickable property protected property_query_map" data-toggle="collapse" data-target=".property_query_map .collapse" title="protected">
|
||
<h2>Query component order mapping
|
||
for complex select queries</h2>
|
||
<pre>$query_map : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description">Format:
|
||
array(
|
||
'type' => 'where',
|
||
'conjunction' => ' AND ',
|
||
'string' => 'k=?'
|
||
)</div></div></div>
|
||
</div>
|
||
<a id="property_select_string"> </a><div class="element clickable property protected property_select_string" data-toggle="collapse" data-target=".property_select_string .collapse" title="protected">
|
||
<h2>Compiled 'select' clause</h2>
|
||
<pre>$select_string : <a href="type.html">\type</a></pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>''</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_set_array_keys"> </a><div class="element clickable property protected property_set_array_keys" data-toggle="collapse" data-target=".property_set_array_keys .collapse" title="protected">
|
||
<h2>Keys for insert/update statement</h2>
|
||
<pre>$set_array_keys : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_set_string"> </a><div class="element clickable property protected property_set_string" data-toggle="collapse" data-target=".property_set_string .collapse" title="protected">
|
||
<h2>Compiled arguments for insert / update</h2>
|
||
<pre>$set_string : string</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_values"> </a><div class="element clickable property protected property_values" data-toggle="collapse" data-target=".property_values .collapse" title="protected">
|
||
<h2>Values to apply to prepared statements</h2>
|
||
<pre>$values : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
|
||
</div>
|
||
<a id="property_where_values"> </a><div class="element clickable property protected property_where_values" data-toggle="collapse" data-target=".property_where_values .collapse" title="protected">
|
||
<h2>Values to apply to where clauses in prepared statements</h2>
|
||
<pre>$where_values : array</pre>
|
||
<div class="row collapse"><div class="detail-description">
|
||
<h3>Default</h3>
|
||
<div class="subelement argument"><code>array()</code></div>
|
||
</div></div>
|
||
<div class="labels"></div>
|
||
<div class="row collapse"><div class="detail-description"><div class="long_description"></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-03-31T15:56:17-04:00.<br></footer></div>
|
||
</div>
|
||
</body>
|
||
</html>
|