aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
433448fd8d
Query/apiDocumentation/classes/Query-QueryBuilderInterface.html

2848 lines
156 KiB
HTML
Raw Normal View History

Cleanup docs
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 -interface">
<h2 class="phpdocumentor-content__title">
QueryBuilderInterface
<div class="phpdocumentor-element__package">
in
<ul class="phpdocumentor-breadcrumbs">
<li><a href="packages/Query.html">Query</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">61</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Interface defining the Query Builder class</p>
<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 -method -public">
<a href="classes/Query-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.html#method_explain">explain()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Shows the query plan for the query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.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-QueryBuilderInterface.html#method_whereNotIn">whereNotIn()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>WHERE NOT IN (FOO) clause</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Query-QueryBuilderInterface.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_countAll">
countAll()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">262</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.262" class="phpdocumentor-element-found-in__source" data-line="262" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">270</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">302</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.302" class="phpdocumentor-element-found-in__source" data-line="302" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">94</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.94" class="phpdocumentor-element-found-in__source" data-line="94" data-modal="source-view"></a>
Cleanup docs
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_explain">
explain()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">99</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.99" class="phpdocumentor-element-found-in__source" data-line="99" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</aside>
<p class="phpdocumentor-summary">Shows the query plan for the query</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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">111</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.111" class="phpdocumentor-element-found-in__source" data-line="111" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">252</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.252" class="phpdocumentor-element-found-in__source" data-line="252" data-modal="source-view"></a>
Cleanup docs
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_getCompiledDelete">
getCompiledDelete()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">325</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.325" class="phpdocumentor-element-found-in__source" data-line="325" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">315</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.315" class="phpdocumentor-element-found-in__source" data-line="315" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">310</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.310" class="phpdocumentor-element-found-in__source" data-line="310" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">320</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.320" class="phpdocumentor-element-found-in__source" data-line="320" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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_getWhere">
getWhere()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">257</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.257" class="phpdocumentor-element-found-in__source" data-line="257" data-modal="source-view"></a>
Cleanup docs
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">array&lt;string|int, mixed&gt;&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">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">202</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.202" class="phpdocumentor-element-found-in__source" data-line="202" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">243</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.243" class="phpdocumentor-element-found-in__source" data-line="243" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">220</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.220" class="phpdocumentor-element-found-in__source" data-line="220" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">142</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.142" class="phpdocumentor-element-found-in__source" data-line="142" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">275</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.275" class="phpdocumentor-element-found-in__source" data-line="275" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">282</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view"></a>
Cleanup docs
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">array&lt;string|int, mixed&gt;&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">array&lt;string|int, mixed&gt;</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_join">
join()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">197</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.197" class="phpdocumentor-element-found-in__source" data-line="197" data-modal="source-view"></a>
Cleanup docs
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_like">
like()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">119</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.119" class="phpdocumentor-element-found-in__source" data-line="119" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">212</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.212" class="phpdocumentor-element-found-in__source" data-line="212" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">226</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.226" class="phpdocumentor-element-found-in__source" data-line="226" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">129</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.129" class="phpdocumentor-element-found-in__source" data-line="129" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_orderBy">
orderBy()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">207</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.207" class="phpdocumentor-element-found-in__source" data-line="207" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">232</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.232" class="phpdocumentor-element-found-in__source" data-line="232" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">147</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.147" class="phpdocumentor-element-found-in__source" data-line="147" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">124</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.124" class="phpdocumentor-element-found-in__source" data-line="124" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">238</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.238" class="phpdocumentor-element-found-in__source" data-line="238" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">134</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.134" class="phpdocumentor-element-found-in__source" data-line="134" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">164</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.164" class="phpdocumentor-element-found-in__source" data-line="164" data-modal="source-view"></a>
Cleanup docs
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">string&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">string</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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">174</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.174" class="phpdocumentor-element-found-in__source" data-line="174" data-modal="source-view"></a>
Cleanup docs
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">$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">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_orWhereNotIn">
orWhereNotIn()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">184</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.184" class="phpdocumentor-element-found-in__source" data-line="184" data-modal="source-view"></a>
Cleanup docs
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">$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">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_resetQuery">
resetQuery()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">333</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.333" class="phpdocumentor-element-found-in__source" data-line="333" data-modal="source-view"></a>
Cleanup docs
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_select">
select()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">69</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.69" class="phpdocumentor-element-found-in__source" data-line="69" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">84</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.84" class="phpdocumentor-element-found-in__source" data-line="84" data-modal="source-view"></a>
Cleanup docs
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>
Update docs and repo tooling
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>
Cleanup docs
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>
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">74</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view"></a>
Cleanup docs
2023-01-20 11:30:51 -05:00
</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>
Update docs and repo tooling
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>
Cleanup docs
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>
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">79</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.79" class="phpdocumentor-element-found-in__source" data-line="79" data-modal="source-view"></a>
Cleanup docs
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>
Update docs and repo tooling
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>
Cleanup docs
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>
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">89</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.89" class="phpdocumentor-element-found-in__source" data-line="89" data-modal="source-view"></a>
Cleanup docs
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>
Update docs and repo tooling
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>
Cleanup docs
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>
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
: <span class="phpdocumentor-signature__argument__return-type">bool|string</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">192</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.192" class="phpdocumentor-element-found-in__source" data-line="192" data-modal="source-view"></a>
Cleanup docs
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">$values</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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_table">
table()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">106</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.106" class="phpdocumentor-element-found-in__source" data-line="106" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_update">
update()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">287</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.287" class="phpdocumentor-element-found-in__source" data-line="287" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">297</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.297" class="phpdocumentor-element-found-in__source" data-line="297" data-modal="source-view"></a>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">157</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.157" class="phpdocumentor-element-found-in__source" data-line="157" data-modal="source-view"></a>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">169</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.169" class="phpdocumentor-element-found-in__source" data-line="169" data-modal="source-view"></a>
Cleanup docs
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">$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">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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_whereNotIn">
whereNotIn()
<a href="classes/Query-QueryBuilderInterface.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/QueryBuilderInterface.php"><a href="files/src-querybuilderinterface.html"><abbr title="src/QueryBuilderInterface.php">QueryBuilderInterface.php</abbr></a></abbr>
:
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<span class="phpdocumentor-element-found-in__line">179</span>
Cleanup docs
2023-01-20 11:30:51 -05:00
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<a href="classes/Query-QueryBuilderInterface.html#source-view.179" class="phpdocumentor-element-found-in__source" data-line="179" data-modal="source-view"></a>
Cleanup docs
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">$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">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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">
Update docs and repo tooling
2023-03-17 16:28:07 -04:00
<section class="phpdocumentor-description"></section>
Cleanup docs
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>
</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/QueryBuilderInterface.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-QueryBuilderInterface.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>
Reference in New Issue Copy Permalink