Query/apiDocumentation/classes/Query-QueryBuilder.html

4726 lines
239 KiB
HTML
Raw Permalink Normal View History

2023-01-20 11:30:51 -05:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/query.html" class="">Query</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/query-drivers.html" class="">Drivers</a>
</li>
<li>
<a href="namespaces/query-exception.html" class="">Exception</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Query.html" class="">Query</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query.html">Query</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
QueryBuilder
<span class="phpdocumentor-element__extends">
extends <a href="classes/Query-QueryBuilderBase.html"><abbr title="\Query\QueryBuilderBase">QueryBuilderBase</abbr></a>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Query.html">Query</a></li>
</ul>
</div>
<span class="phpdocumentor-element__implements">
implements
<a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a> </span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">28</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.28" class="phpdocumentor-element-found-in__source" data-line="28" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Convenience class for creating sql queries</p>
<h3 id="interfaces_class_traits">
Interfaces, Classes, Traits and Enums
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a></dt>
<dd>Interface defining the Query Builder class</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Query-QueryBuilderBase.html#property_connName">$connName</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Convenience property for connection management</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/Query-QueryBuilderBase.html#property_queries">$queries</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>List of queries executed</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method___call">__call()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Calls a function further down the inheritance chain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
2023-03-17 16:28:07 -04:00
<dd></dd>
2023-01-20 11:30:51 -05:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method___destruct">__destruct()</a>
<span>
&nbsp;: mixed </span>
</dt>
2023-03-17 16:28:07 -04:00
<dd></dd>
2023-01-20 11:30:51 -05:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_affectedRows">affectedRows()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_beginTransaction">beginTransaction()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_commit">commit()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_countAll">countAll()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Retrieve the number of rows in the selected table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_countAllResults">countAllResults()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Retrieve the number of results for the generated query - used
in place of the get() method</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_delete">delete()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Deletes data from a table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_distinct">distinct()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Adds the &#039;distinct&#039; keyword to a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_errorCode">errorCode()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_errorInfo">errorInfo()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_exec">exec()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_explain">explain()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Tell the database to give you the query plan instead of result set</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_from">from()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Specify the database table to select from</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_get">get()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Select and retrieve all records from the current table, and/or
execute current compiled query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getAttribute">getAttribute()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getColumns">getColumns()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_getCompiledDelete">getCompiledDelete()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the generated &#039;delete&#039; sql query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_getCompiledInsert">getCompiledInsert()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the generated &#039;insert&#039; sql query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_getCompiledSelect">getCompiledSelect()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the generated &#039;select&#039; sql query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_getCompiledUpdate">getCompiledUpdate()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the generated &#039;update&#039; sql query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getDbs">getDbs()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getFks">getFks()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getIndexes">getIndexes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getLastQuery">getLastQuery()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getSchemas">getSchemas()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getSequences">getSequences()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getSystemTables">getSystemTables()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getTables">getTables()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getTypes">getTypes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getUtil">getUtil()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getVersion">getVersion()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_getViews">getViews()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_getWhere">getWhere()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Convenience method for get() with a where clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_groupBy">groupBy()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Group the results by the selected field(s)</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_groupEnd">groupEnd()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Ends a query group</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_groupStart">groupStart()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Adds a paren to the current query for query grouping</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_having">having()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Generates a &#039;Having&#039; clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_insert">insert()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Creates an insert clause, and executes it</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_insertBatch">insertBatch()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr>|null </span>
</dt>
<dd>Creates and executes a batch insertion query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_inTransaction">inTransaction()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_join">join()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Creates a join phrase in a compiled query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_lastInsertId">lastInsertId()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_like">like()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Creates a Like clause in the sql statement</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_limit">limit()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set a limit on the current sql statement</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_notGroupStart">notGroupStart()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Adds a paren to the current query for query grouping,
prefixed with &#039;NOT&#039;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_notLike">notLike()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Generates a NOT LIKE clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_numRows">numRows()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orderBy">orderBy()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Order the results by the selected field(s)</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orGroupStart">orGroupStart()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Adds a paren to the current query for query grouping,
prefixed with &#039;OR&#039;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orHaving">orHaving()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Generates a &#039;Having&#039; clause prefixed with &#039;OR&#039;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orLike">orLike()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Generates an OR Like clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orNotGroupStart">orNotGroupStart()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Adds a paren to the current query for query grouping,
prefixed with &#039;OR NOT&#039;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orNotLike">orNotLike()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Generates a OR NOT LIKE clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orWhere">orWhere()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Where clause prefixed with &quot;OR&quot;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orWhereIn">orWhereIn()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Where in statement prefixed with &quot;or&quot;</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_orWhereNotIn">orWhereNotIn()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>OR WHERE NOT IN (FOO) clause</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_prepare">prepare()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_prepareExecute">prepareExecute()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_prepareQuery">prepareQuery()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_query">query()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_quote">quote()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_resetQuery">resetQuery()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Clear out the class variables, so the next query can be run</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_returning">returning()</a>
<span>
&nbsp;: $this </span>
</dt>
<dd>Add a &#039;returning&#039; clause to an insert,update, or delete query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_rollback">rollback()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_select">select()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Specifies rows to select in a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_selectAvg">selectAvg()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Selects the average value of a field from a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_selectMax">selectMax()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Selects the maximum value of a field from a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_selectMin">selectMin()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Selects the minimum value of a field from a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_selectSum">selectSum()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Selects the sum of a field from a query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_set">set()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Sets values for inserts / updates / deletes</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_setAttribute">setAttribute()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_setTablePrefix">setTablePrefix()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_table">table()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Specify the database table to select from</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderBase.html#method_truncate">truncate()</a>
<span>
&nbsp;: void </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_update">update()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Creates an update clause, and executes it</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_updateBatch">updateBatch()</a>
<span>
&nbsp;: int|null </span>
</dt>
<dd>Creates a batch update, and executes it.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_where">where()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>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</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_whereIn">whereIn()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Where clause with &#039;IN&#039; statement</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilder.html#method_whereNotIn">whereNotIn()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>WHERE NOT IN (FOO) clause</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/Query-QueryBuilder.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_connName">
$connName
<a href="classes/Query-QueryBuilderBase.html#property_connName" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">67</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.67" class="phpdocumentor-element-found-in__source" data-line="67" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Convenience property for connection management</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$connName</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_queries">
$queries
<a href="classes/Query-QueryBuilderBase.html#property_queries" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">72</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.72" class="phpdocumentor-element-found-in__source" data-line="72" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">List of queries executed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$queries</span>
= <span class="phpdocumentor-signature__default-value">[&#039;total_time&#039; =&gt; 0]</span></code>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Query-QueryBuilder.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___call">
__call()
<a href="classes/Query-QueryBuilderBase.html#method___call" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">113</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Calls a function further down the inheritance chain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>'Implements' methods on the driver object</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\BadMethodCallException">BadMethodCallException</abbr></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/Query-QueryBuilderBase.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
<a href="classes/Query-QueryBuilder.html#source-view.94" class="phpdocumentor-element-found-in__source" data-line="94" data-modal="source-view"></a>
</aside>
2023-03-17 16:28:07 -04:00
2023-01-20 11:30:51 -05:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$driver</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-QueryParser.html"><abbr title="\Query\QueryParser">QueryParser</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parser</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$driver</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a>|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parser</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-QueryParser.html"><abbr title="\Query\QueryParser">QueryParser</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___destruct">
__destruct()
<a href="classes/Query-QueryBuilderBase.html#method___destruct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">100</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.100" class="phpdocumentor-element-found-in__source" data-line="100" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
2023-03-17 16:28:07 -04:00
2023-01-20 11:30:51 -05:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__destruct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_affectedRows">
affectedRows()
<a href="classes/Query-QueryBuilderBase.html#method_affectedRows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">affectedRows</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: int</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_beginTransaction">
beginTransaction()
<a href="classes/Query-QueryBuilderBase.html#method_beginTransaction" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">beginTransaction</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: bool</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_commit">
commit()
<a href="classes/Query-QueryBuilderBase.html#method_commit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">commit</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: bool</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_countAll">
countAll()
<a href="classes/Query-QueryBuilder.html#method_countAll" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">511</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.511" class="phpdocumentor-element-found-in__source" data-line="511" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Retrieve the number of rows in the selected table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">countAll</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_countAllResults">
countAllResults()
<a href="classes/Query-QueryBuilder.html#method_countAllResults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">523</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.523" class="phpdocumentor-element-found-in__source" data-line="523" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Retrieve the number of results for the generated query - used
in place of the get() method</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">countAllResults</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$reset</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>Whether to keep the query after counting the results</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_delete">
delete()
<a href="classes/Query-QueryBuilder.html#method_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">598</span>
<a href="classes/Query-QueryBuilder.html#source-view.598" class="phpdocumentor-element-found-in__source" data-line="598" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Deletes data from a table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$where</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$where</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_distinct">
distinct()
<a href="classes/Query-QueryBuilder.html#method_distinct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">136</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.136" class="phpdocumentor-element-found-in__source" data-line="136" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Adds the &#039;distinct&#039; keyword to a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">distinct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_errorCode">
errorCode()
<a href="classes/Query-QueryBuilderBase.html#method_errorCode" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">errorCode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: string</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_errorInfo">
errorInfo()
<a href="classes/Query-QueryBuilderBase.html#method_errorInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">errorInfo</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_exec">
exec()
<a href="classes/Query-QueryBuilderBase.html#method_exec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">exec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: int</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statement</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_explain">
explain()
<a href="classes/Query-QueryBuilder.html#method_explain" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">147</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.147" class="phpdocumentor-element-found-in__source" data-line="147" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Tell the database to give you the query plan instead of result set</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">explain</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_from">
from()
<a href="classes/Query-QueryBuilder.html#method_from" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">167</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.167" class="phpdocumentor-element-found-in__source" data-line="167" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Specify the database table to select from</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">from</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$tableName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tableName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get">
get()
<a href="classes/Query-QueryBuilder.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">477</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.477" class="phpdocumentor-element-found-in__source" data-line="477" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Select and retrieve all records from the current table, and/or
execute current compiled query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getAttribute">
getAttribute()
<a href="classes/Query-QueryBuilderBase.html#method_getAttribute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getAttribute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attribute</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getColumns">
getColumns()
<a href="classes/Query-QueryBuilderBase.html#method_getColumns" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getColumns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCompiledDelete">
getCompiledDelete()
<a href="classes/Query-QueryBuilder.html#method_getCompiledDelete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">645</span>
<a href="classes/Query-QueryBuilder.html#source-view.645" class="phpdocumentor-element-found-in__source" data-line="645" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Returns the generated &#039;delete&#039; sql query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCompiledDelete</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$reset</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCompiledInsert">
getCompiledInsert()
<a href="classes/Query-QueryBuilder.html#method_getCompiledInsert" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">629</span>
<a href="classes/Query-QueryBuilder.html#source-view.629" class="phpdocumentor-element-found-in__source" data-line="629" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Returns the generated &#039;insert&#039; sql query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCompiledInsert</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$reset</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCompiledSelect">
getCompiledSelect()
<a href="classes/Query-QueryBuilder.html#method_getCompiledSelect" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">615</span>
<a href="classes/Query-QueryBuilder.html#source-view.615" class="phpdocumentor-element-found-in__source" data-line="615" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Returns the generated &#039;select&#039; sql query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCompiledSelect</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$reset</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCompiledUpdate">
getCompiledUpdate()
<a href="classes/Query-QueryBuilder.html#method_getCompiledUpdate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">637</span>
<a href="classes/Query-QueryBuilder.html#source-view.637" class="phpdocumentor-element-found-in__source" data-line="637" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Returns the generated &#039;update&#039; sql query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCompiledUpdate</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$reset</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDbs">
getDbs()
<a href="classes/Query-QueryBuilderBase.html#method_getDbs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDbs</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFks">
getFks()
<a href="classes/Query-QueryBuilderBase.html#method_getFks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getIndexes">
getIndexes()
<a href="classes/Query-QueryBuilderBase.html#method_getIndexes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getIndexes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getLastQuery">
getLastQuery()
<a href="classes/Query-QueryBuilderBase.html#method_getLastQuery" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getLastQuery</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: string</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSchemas">
getSchemas()
<a href="classes/Query-QueryBuilderBase.html#method_getSchemas" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSchemas</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSequences">
getSequences()
<a href="classes/Query-QueryBuilderBase.html#method_getSequences" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSequences</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSystemTables">
getSystemTables()
<a href="classes/Query-QueryBuilderBase.html#method_getSystemTables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSystemTables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTables">
getTables()
<a href="classes/Query-QueryBuilderBase.html#method_getTables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTypes">
getTypes()
<a href="classes/Query-QueryBuilderBase.html#method_getTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTypes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getUtil">
getUtil()
<a href="classes/Query-QueryBuilderBase.html#method_getUtil" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getUtil</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: \Query\Drivers\AbstractUtil</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getVersion">
getVersion()
<a href="classes/Query-QueryBuilderBase.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: string</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getViews">
getViews()
<a href="classes/Query-QueryBuilderBase.html#method_getViews" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getViews</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: array | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getWhere">
getWhere()
<a href="classes/Query-QueryBuilder.html#method_getWhere" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">499</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.499" class="phpdocumentor-element-found-in__source" data-line="499" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Convenience method for get() with a where clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getWhere</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$where</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$where</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_groupBy">
groupBy()
<a href="classes/Query-QueryBuilder.html#method_groupBy" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">344</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.344" class="phpdocumentor-element-found-in__source" data-line="344" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Group the results by the selected field(s)</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">groupBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_groupEnd">
groupEnd()
<a href="classes/Query-QueryBuilder.html#method_groupEnd" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">463</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.463" class="phpdocumentor-element-found-in__source" data-line="463" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Ends a query group</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">groupEnd</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_groupStart">
groupStart()
<a href="classes/Query-QueryBuilder.html#method_groupStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">416</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.416" class="phpdocumentor-element-found-in__source" data-line="416" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Adds a paren to the current query for query grouping</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">groupStart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_having">
having()
<a href="classes/Query-QueryBuilder.html#method_having" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">224</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.224" class="phpdocumentor-element-found-in__source" data-line="224" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Generates a &#039;Having&#039; clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">having</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_insert">
insert()
<a href="classes/Query-QueryBuilder.html#method_insert" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">540</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.540" class="phpdocumentor-element-found-in__source" data-line="540" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates an insert clause, and executes it</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">insert</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_insertBatch">
insertBatch()
<a href="classes/Query-QueryBuilder.html#method_insertBatch" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">553</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.553" class="phpdocumentor-element-found-in__source" data-line="553" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates and executes a batch insertion query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">insertBatch</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr>|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr>|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_inTransaction">
inTransaction()
<a href="classes/Query-QueryBuilderBase.html#method_inTransaction" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">inTransaction</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: bool</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_join">
join()
<a href="classes/Query-QueryBuilder.html#method_join" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">324</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.324" class="phpdocumentor-element-found-in__source" data-line="324" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates a join phrase in a compiled query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">join</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$condition</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-JoinType.html"><abbr title="\Query\JoinType">JoinType</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">JoinType::INNER</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$condition</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-JoinType.html"><abbr title="\Query\JoinType">JoinType</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">JoinType::INNER</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_lastInsertId">
lastInsertId()
<a href="classes/Query-QueryBuilderBase.html#method_lastInsertId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">lastInsertId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name = NULL</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: string</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name = NULL</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_like">
like()
<a href="classes/Query-QueryBuilder.html#method_like" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">189</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.189" class="phpdocumentor-element-found-in__source" data-line="189" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates a Like clause in the sql statement</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">like</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pos</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pos</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_limit">
limit()
<a href="classes/Query-QueryBuilder.html#method_limit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">402</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.402" class="phpdocumentor-element-found-in__source" data-line="402" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Set a limit on the current sql statement</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">limit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_notGroupStart">
notGroupStart()
<a href="classes/Query-QueryBuilder.html#method_notGroupStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">429</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.429" class="phpdocumentor-element-found-in__source" data-line="429" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Adds a paren to the current query for query grouping,
prefixed with &#039;NOT&#039;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">notGroupStart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_notLike">
notLike()
<a href="classes/Query-QueryBuilder.html#method_notLike" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">205</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.205" class="phpdocumentor-element-found-in__source" data-line="205" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Generates a NOT LIKE clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">notLike</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pos</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pos</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_numRows">
numRows()
<a href="classes/Query-QueryBuilderBase.html#method_numRows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">numRows</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: int | null</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orderBy">
orderBy()
<a href="classes/Query-QueryBuilder.html#method_orderBy" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">367</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.367" class="phpdocumentor-element-found-in__source" data-line="367" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Order the results by the selected field(s)</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orderBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orGroupStart">
orGroupStart()
<a href="classes/Query-QueryBuilder.html#method_orGroupStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">442</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.442" class="phpdocumentor-element-found-in__source" data-line="442" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Adds a paren to the current query for query grouping,
prefixed with &#039;OR&#039;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orGroupStart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orHaving">
orHaving()
<a href="classes/Query-QueryBuilder.html#method_orHaving" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">232</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.232" class="phpdocumentor-element-found-in__source" data-line="232" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Generates a &#039;Having&#039; clause prefixed with &#039;OR&#039;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orHaving</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orLike">
orLike()
<a href="classes/Query-QueryBuilder.html#method_orLike" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">197</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.197" class="phpdocumentor-element-found-in__source" data-line="197" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Generates an OR Like clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orLike</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pos</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pos</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orNotGroupStart">
orNotGroupStart()
<a href="classes/Query-QueryBuilder.html#method_orNotGroupStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">453</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.453" class="phpdocumentor-element-found-in__source" data-line="453" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Adds a paren to the current query for query grouping,
prefixed with &#039;OR NOT&#039;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orNotGroupStart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orNotLike">
orNotLike()
<a href="classes/Query-QueryBuilder.html#method_orNotLike" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">213</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.213" class="phpdocumentor-element-found-in__source" data-line="213" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Generates a OR NOT LIKE clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orNotLike</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pos</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pos</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Query-LikeType.html"><abbr title="\Query\LikeType">LikeType</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">LikeType::BOTH</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orWhere">
orWhere()
<a href="classes/Query-QueryBuilder.html#method_orWhere" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">253</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.253" class="phpdocumentor-element-found-in__source" data-line="253" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Where clause prefixed with &quot;OR&quot;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orWhere</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orWhereIn">
orWhereIn()
<a href="classes/Query-QueryBuilder.html#method_orWhereIn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">269</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.269" class="phpdocumentor-element-found-in__source" data-line="269" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Where in statement prefixed with &quot;or&quot;</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orWhereIn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$val</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_orWhereNotIn">
orWhereNotIn()
<a href="classes/Query-QueryBuilder.html#method_orWhereNotIn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">285</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.285" class="phpdocumentor-element-found-in__source" data-line="285" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">OR WHERE NOT IN (FOO) clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">orWhereNotIn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$val</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_prepare">
prepare()
<a href="classes/Query-QueryBuilderBase.html#method_prepare" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prepare</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$driver_options = []</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: PDOStatement</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statement</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$driver_options = []</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_prepareExecute">
prepareExecute()
<a href="classes/Query-QueryBuilderBase.html#method_prepareExecute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prepareExecute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: PDOStatement</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_prepareQuery">
prepareQuery()
<a href="classes/Query-QueryBuilderBase.html#method_prepareQuery" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prepareQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: PDOStatement</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_query">
query()
<a href="classes/Query-QueryBuilderBase.html#method_query" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">query</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: PDOStatement</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statement</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_quote">
quote()
<a href="classes/Query-QueryBuilderBase.html#method_quote" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">quote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parameter_type = PDO::PARAM_STR</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: string</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parameter_type = PDO::PARAM_STR</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_resetQuery">
resetQuery()
<a href="classes/Query-QueryBuilderBase.html#method_resetQuery" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">126</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.126" class="phpdocumentor-element-found-in__source" data-line="126" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Clear out the class variables, so the next query can be run</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">resetQuery</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_returning">
returning()
<a href="classes/Query-QueryBuilder.html#method_returning" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">120</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.120" class="phpdocumentor-element-found-in__source" data-line="120" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Add a &#039;returning&#039; clause to an insert,update, or delete query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">returning</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fields</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">$this</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_rollback">
rollback()
<a href="classes/Query-QueryBuilderBase.html#method_rollback" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">rollback</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: bool</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_select">
select()
<a href="classes/Query-QueryBuilder.html#method_select" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">36</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.36" class="phpdocumentor-element-found-in__source" data-line="36" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Specifies rows to select in a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">select</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_selectAvg">
selectAvg()
<a href="classes/Query-QueryBuilder.html#method_selectAvg" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">96</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.96" class="phpdocumentor-element-found-in__source" data-line="96" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Selects the average value of a field from a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-signature__name">selectAvg</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$as</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$as</span>
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_selectMax">
selectMax()
<a href="classes/Query-QueryBuilder.html#method_selectMax" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
<a href="classes/Query-QueryBuilder.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Selects the maximum value of a field from a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-signature__name">selectMax</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$as</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$as</span>
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_selectMin">
selectMin()
<a href="classes/Query-QueryBuilder.html#method_selectMin" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">85</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.85" class="phpdocumentor-element-found-in__source" data-line="85" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Selects the minimum value of a field from a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-signature__name">selectMin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$as</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$as</span>
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_selectSum">
selectSum()
<a href="classes/Query-QueryBuilder.html#method_selectSum" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">107</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.107" class="phpdocumentor-element-found-in__source" data-line="107" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Selects the sum of a field from a query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-signature__name">selectSum</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$as</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
2023-01-20 11:30:51 -05:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$as</span>
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_set">
set()
<a href="classes/Query-QueryBuilder.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">296</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.296" class="phpdocumentor-element-found-in__source" data-line="296" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Sets values for inserts / updates / deletes</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$val</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setAttribute">
setAttribute()
<a href="classes/Query-QueryBuilderBase.html#method_setAttribute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setAttribute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$attribute</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: bool</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setTablePrefix">
setTablePrefix()
<a href="classes/Query-QueryBuilderBase.html#method_setTablePrefix" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setTablePrefix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$prefix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: void</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$prefix</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_table">
table()
<a href="classes/Query-QueryBuilder.html#method_table" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">159</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.159" class="phpdocumentor-element-found-in__source" data-line="159" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Specify the database table to select from</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">table</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$tableName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"><p>Alias of <code class="prettyprint">from</code> method to better match CodeIgniter 4</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tableName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_truncate">
truncate()
<a href="classes/Query-QueryBuilderBase.html#method_truncate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderBase.php"><a href="files/src-querybuilderbase.html"><abbr title="src/QueryBuilderBase.php">QueryBuilderBase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">0</span>
<a href="classes/Query-QueryBuilder.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view"></a>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">truncate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>: PDOStatement</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_update">
update()
<a href="classes/Query-QueryBuilder.html#method_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">566</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.566" class="phpdocumentor-element-found-in__source" data-line="566" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates an update clause, and executes it</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_updateBatch">
updateBatch()
<a href="classes/Query-QueryBuilder.html#method_updateBatch" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">580</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.580" class="phpdocumentor-element-found-in__source" data-line="580" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Creates a batch update, and executes it.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">updateBatch</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$where</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
<section class="phpdocumentor-description"><p>Returns the number of affected rows</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$table</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The table to update</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>an array of update values</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$where</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The where key</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_where">
where()
<a href="classes/Query-QueryBuilder.html#method_where" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">245</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.245" class="phpdocumentor-element-found-in__source" data-line="245" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">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</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">where</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_whereIn">
whereIn()
<a href="classes/Query-QueryBuilder.html#method_whereIn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">261</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.261" class="phpdocumentor-element-found-in__source" data-line="261" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Where clause with &#039;IN&#039; statement</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">whereIn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$val</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_whereNotIn">
whereNotIn()
<a href="classes/Query-QueryBuilder.html#method_whereNotIn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilder.php"><a href="files/src-querybuilder.html"><abbr title="src/QueryBuilder.php">QueryBuilder.php</abbr></a></abbr>
:
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">277</span>
2023-01-20 11:30:51 -05:00
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilder.html#source-view.277" class="phpdocumentor-element-found-in__source" data-line="277" data-modal="source-view"></a>
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">WHERE NOT IN (FOO) clause</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">whereNotIn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$val</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
2023-01-20 11:30:51 -05:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/QueryBuilder.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">X</button>
</div>
</div>
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/Query-QueryBuilder.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>