468 lines
27 KiB
HTML
468 lines
27 KiB
HTML
<!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="-active">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">
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -package">
|
|
<h2 class="phpdocumentor-content__title">Query</h2>
|
|
|
|
|
|
|
|
<h3 id="interfaces_class_traits">
|
|
Interfaces, Classes, Traits and Enums
|
|
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/Query-Drivers-DriverInterface.html"><abbr title="\Query\Drivers\DriverInterface">DriverInterface</abbr></a></dt>
|
|
<dd>PDO Interface to implement for database drivers</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/Query-Drivers-SQLInterface.html"><abbr title="\Query\Drivers\SQLInterface">SQLInterface</abbr></a></dt>
|
|
<dd>Interface for database-specific syntax subclasses</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a></dt>
|
|
<dd>Interface defining the Query Builder class</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-ConnectionManager.html"><abbr title="\Query\ConnectionManager">ConnectionManager</abbr></a></dt>
|
|
<dd>Connection manager class to manage connections for the
|
|
Query method</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-AbstractDriver.html"><abbr title="\Query\Drivers\AbstractDriver">AbstractDriver</abbr></a></dt>
|
|
<dd>Base Database class</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-AbstractSQL.html"><abbr title="\Query\Drivers\AbstractSQL">AbstractSQL</abbr></a></dt>
|
|
<dd>Parent for database-specific syntax subclasses</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-AbstractUtil.html"><abbr title="\Query\Drivers\AbstractUtil">AbstractUtil</abbr></a></dt>
|
|
<dd>Abstract class defining database / table creation methods</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Mysql-Driver.html"><abbr title="\Query\Drivers\Mysql\Driver">Driver</abbr></a></dt>
|
|
<dd>MySQL specific class</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Mysql-SQL.html"><abbr title="\Query\Drivers\Mysql\SQL">SQL</abbr></a></dt>
|
|
<dd>MySQL specific SQL</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Mysql-Util.html"><abbr title="\Query\Drivers\Mysql\Util">Util</abbr></a></dt>
|
|
<dd>MySQL-specific backup, import and creation methods</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Pgsql-Driver.html"><abbr title="\Query\Drivers\Pgsql\Driver">Driver</abbr></a></dt>
|
|
<dd>PostgreSQL specific class</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Pgsql-SQL.html"><abbr title="\Query\Drivers\Pgsql\SQL">SQL</abbr></a></dt>
|
|
<dd>PostgreSQL specific SQL</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Pgsql-Util.html"><abbr title="\Query\Drivers\Pgsql\Util">Util</abbr></a></dt>
|
|
<dd>Postgres-specific backup, import and creation methods</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Sqlite-Driver.html"><abbr title="\Query\Drivers\Sqlite\Driver">Driver</abbr></a></dt>
|
|
<dd>SQLite specific class</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Sqlite-SQL.html"><abbr title="\Query\Drivers\Sqlite\SQL">SQL</abbr></a></dt>
|
|
<dd>SQLite Specific SQL</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Drivers-Sqlite-Util.html"><abbr title="\Query\Drivers\Sqlite\Util">Util</abbr></a></dt>
|
|
<dd>SQLite-specific backup, import and creation methods</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Exception-BadDBDriverException.html"><abbr title="\Query\Exception\BadDBDriverException">BadDBDriverException</abbr></a></dt>
|
|
<dd>Generic exception for bad drivers</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Exception-NonExistentConnectionException.html"><abbr title="\Query\Exception\NonExistentConnectionException">NonExistentConnectionException</abbr></a></dt>
|
|
<dd>Exception for missing database connection</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-Exception-NotImplementedException.html"><abbr title="\Query\Exception\NotImplementedException">NotImplementedException</abbr></a></dt>
|
|
<dd>Exception for non-implemented method</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-QueryBuilder.html"><abbr title="\Query\QueryBuilder">QueryBuilder</abbr></a></dt>
|
|
<dd>Convenience class for creating sql queries</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-QueryBuilderBase.html"><abbr title="\Query\QueryBuilderBase">QueryBuilderBase</abbr></a></dt>
|
|
<dd></dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-QueryParser.html"><abbr title="\Query\QueryParser">QueryParser</abbr></a></dt>
|
|
<dd>Utility Class to parse sql clauses for properly escaping identifiers</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Query-State.html"><abbr title="\Query\State">State</abbr></a></dt>
|
|
<dd>Query builder state</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a href="namespaces/default.html#function_mb_trim">mb_trim()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Multibyte-safe trim function</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a href="namespaces/default.html#function_dbFilter">dbFilter()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Filter out db rows into one array</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a href="namespaces/default.html#function_arrayZipper">arrayZipper()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Zip a set of arrays together on common keys</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a href="namespaces/default.html#function_regexInArray">regexInArray()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Determine whether a value in the passed array matches the pattern
|
|
passed</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a href="namespaces/default.html#function_Query">Query()</a>
|
|
<span>
|
|
: <a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a>|null </span>
|
|
</dt>
|
|
<dd>Connection function</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<section class="phpdocumentor-functions">
|
|
<h3 class="phpdocumentor-elements__header" id="functions">
|
|
Functions
|
|
<a href="packages/Query.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mb_trim">
|
|
mb_trim()
|
|
<a href="namespaces/default.html#function_mb_trim" 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/common.php"><a href="files/src-common.html"><abbr title="src/common.php">common.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">25</span>
|
|
|
|
<a href="packages/Query.html#source-view.25" class="phpdocumentor-element-found-in__source" data-line="25" data-modal="source-view"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Multibyte-safe trim function</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mb_trim</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</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">$string</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">string</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_dbFilter">
|
|
dbFilter()
|
|
<a href="namespaces/default.html#function_dbFilter" 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/common.php"><a href="files/src-common.html"><abbr title="src/common.php">common.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
|
<a href="packages/Query.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Filter out db rows into one array</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">dbFilter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$array</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$index</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></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">$array</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></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">$index</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_arrayZipper">
|
|
arrayZipper()
|
|
<a href="namespaces/default.html#function_arrayZipper" 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/common.php"><a href="files/src-common.html"><abbr title="src/common.php">common.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">51</span>
|
|
|
|
<a href="packages/Query.html#source-view.51" class="phpdocumentor-element-found-in__source" data-line="51" data-modal="source-view"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Zip a set of arrays together on common keys</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">arrayZipper</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$zipperInput</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>The $zipperInput array is an array of arrays indexed by their place in the output
|
|
array.</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">$zipperInput</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_regexInArray">
|
|
regexInArray()
|
|
<a href="namespaces/default.html#function_regexInArray" 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/common.php"><a href="files/src-common.html"><abbr title="src/common.php">common.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">74</span>
|
|
|
|
<a href="packages/Query.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Determine whether a value in the passed array matches the pattern
|
|
passed</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">regexInArray</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$array</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$pattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$array</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></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">$pattern</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">bool</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_Query">
|
|
Query()
|
|
<a href="namespaces/default.html#function_Query" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/common.php"><a href="files/src-common.html"><abbr title="src/common.php">common.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">100</span>
|
|
|
|
<a href="packages/Query.html#source-view.100" class="phpdocumentor-element-found-in__source" data-line="100" data-modal="source-view"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Connection function</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">Query</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|object|array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a>|null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Send an array or object as connection parameters to create a connection. If
|
|
the array or object has an 'alias' parameter, passing that string to this
|
|
function will return that connection. Passing no parameters returns the last
|
|
connection created.</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">$params</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string|object|array<string|int, mixed>|null</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/Query-QueryBuilderInterface.html"><abbr title="\Query\QueryBuilderInterface">QueryBuilderInterface</abbr></a>|null</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
</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="packages/Query.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>
|