aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity
develop
Query/apiDocumentation/classes/Query-Drivers-Mysql-Driver.html
Timothy J. Warren 1bfbcf2ffe Cleanup docs
2023-01-20 11:30:51 -05:00

2042 lines
103 KiB
HTML
Raw Permalink Blame History

<!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>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query-drivers.html">Drivers</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/query-drivers-mysql.html">Mysql</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Driver
<span class="phpdocumentor-element__extends">
extends <a href="classes/Query-Drivers-AbstractDriver.html"><abbr title="\Query\Drivers\AbstractDriver">AbstractDriver</abbr></a>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Query.html">Query</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Mysql/Driver.php"><a href="files/src-drivers-mysql-driver.html"><abbr title="src/Drivers/Mysql/Driver.php">Driver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.25" class="phpdocumentor-element-found-in__source" data-line="25" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">MySQL specific 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-Drivers-AbstractDriver.html#method___call">__call()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Allow invoke to work on table object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Mysql-Driver.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Connect to MySQL Database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method__quote">_quote()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Helper method for quote_ident</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_affectedRows">affectedRows()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Returns number of rows affected by an INSERT, UPDATE, DELETE type query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_driverQuery">driverQuery()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Method to simplify retrieving db results for meta-data queries</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getColumns">getColumns()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Retrieve column information for the current database table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getDbs">getDbs()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of dbs for the current connection, if possible</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getFks">getFks()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Retrieve foreign keys for the table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getFunctions">getFunctions()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of functions for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getIndexes">getIndexes()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Retrieve indexes for the table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getLastQuery">getLastQuery()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the last sql query executed</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getProcedures">getProcedures()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of stored procedures for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSchemas">getSchemas()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return schemas for databases that list them</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSequences">getSequences()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of sequences for the current database, if they exist</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSql">getSql()</a>
<span>
&nbsp;: <a href="classes/Query-Drivers-SQLInterface.html"><abbr title="\Query\Drivers\SQLInterface">SQLInterface</abbr></a> </span>
</dt>
<dd>Get the SQL class for the current driver</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSystemTables">getSystemTables()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Retrieves an array of non-user-created tables for
the connection/database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTables">getTables()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of tables for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTriggers">getTriggers()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of triggers for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTypes">getTypes()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Retrieve list of data types for the database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getUtil">getUtil()</a>
<span>
&nbsp;: <a href="classes/Query-Drivers-AbstractUtil.html"><abbr title="\Query\Drivers\AbstractUtil">AbstractUtil</abbr></a> </span>
</dt>
<dd>Get the Util class for the current driver</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getVersion">getVersion()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the version of the database engine</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_getViews">getViews()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|null </span>
</dt>
<dd>Return list of views for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_insertBatch">insertBatch()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Create sql for batch insert</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_numRows">numRows()</a>
<span>
&nbsp;: int|null </span>
</dt>
<dd>Return the number of rows returned for a SELECT query</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_prefixTable">prefixTable()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Prefixes a table if it is not already prefixed</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_prepareExecute">prepareExecute()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Create and execute a prepared statement with the provided parameters</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_prepareQuery">prepareQuery()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Simplifies prepared statements for database queries</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_quoteIdent">quoteIdent()</a>
<span>
&nbsp;: string|array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Surrounds the string with the databases identifier escape characters</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_quoteTable">quoteTable()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Quote database table name, and set prefix</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-Mysql-Driver.html#method_returning">returning()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Generate the returning clause for the current database</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_setLastQuery">setLastQuery()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set the last query sql</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_setTablePrefix">setTablePrefix()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set the common table name prefix</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_truncate">truncate()</a>
<span>
&nbsp;: <abbr title="\PDOStatement">PDOStatement</abbr> </span>
</dt>
<dd>Empty the passed table</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Query-Drivers-AbstractDriver.html#method_updateBatch">updateBatch()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Creates a batch update, and executes it.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Query-Drivers-Mysql-Driver.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___call">
__call()
<a href="classes/Query-Drivers-AbstractDriver.html#method___call" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.111" class="phpdocumentor-element-found-in__source" data-line="111" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Allow invoke to work on table object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$args</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">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/Query-Drivers-Mysql-Driver.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Mysql/Driver.php"><a href="files/src-drivers-mysql-driver.html"><abbr title="src/Drivers/Mysql/Driver.php">Driver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Connect to MySQL Database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$dsn</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">$username</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">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$password</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">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$dsn</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">$username</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">$password</span>
: <span class="phpdocumentor-signature__argument__return-type">string</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">$options</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">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method__quote">
_quote()
<a href="classes/Query-Drivers-AbstractDriver.html#method__quote" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">599</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.599" class="phpdocumentor-element-found-in__source" data-line="599" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Helper method for quote_ident</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">_quote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$str</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</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">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_affectedRows">
affectedRows()
<a href="classes/Query-Drivers-AbstractDriver.html#method_affectedRows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">210</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.210" class="phpdocumentor-element-found-in__source" data-line="210" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Returns number of rows affected by an INSERT, UPDATE, DELETE type query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">affectedRows</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<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_driverQuery">
driverQuery()
<a href="classes/Query-Drivers-AbstractDriver.html#method_driverQuery" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">422</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.422" class="phpdocumentor-element-found-in__source" data-line="422" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Method to simplify retrieving db results for meta-data queries</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">driverQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$query</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">$filteredIndex</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">array&lt;string|int, mixed&gt;|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">$query</span>
: <span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;</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">$filteredIndex</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">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getColumns">
getColumns()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getColumns" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">382</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.382" class="phpdocumentor-element-found-in__source" data-line="382" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve column information for the current database table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getColumns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|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>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDbs">
getDbs()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getDbs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">317</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.317" class="phpdocumentor-element-found-in__source" data-line="317" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of dbs for the current connection, if possible</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDbs</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFks">
getFks()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getFks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">390</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.390" class="phpdocumentor-element-found-in__source" data-line="390" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve foreign keys for the table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|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>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_getFunctions">
getFunctions()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getFunctions" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">345</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.345" class="phpdocumentor-element-found-in__source" data-line="345" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of functions for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFunctions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Will be removed in next version</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getIndexes">
getIndexes()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getIndexes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">398</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.398" class="phpdocumentor-element-found-in__source" data-line="398" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve indexes for the table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getIndexes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|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>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getLastQuery">
getLastQuery()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getLastQuery" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.131" class="phpdocumentor-element-found-in__source" data-line="131" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Get the last sql query executed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getLastQuery</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<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
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_getProcedures">
getProcedures()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getProcedures" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">355</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.355" class="phpdocumentor-element-found-in__source" data-line="355" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of stored procedures for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getProcedures</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Will be removed in next version</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSchemas">
getSchemas()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSchemas" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">298</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.298" class="phpdocumentor-element-found-in__source" data-line="298" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return schemas for databases that list them</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSchemas</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSequences">
getSequences()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSequences" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">335</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.335" class="phpdocumentor-element-found-in__source" data-line="335" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of sequences for the current database, if they exist</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSequences</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSql">
getSql()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSql" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.147" class="phpdocumentor-element-found-in__source" data-line="147" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Get the SQL class for the current driver</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSql</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-SQLInterface.html"><abbr title="\Query\Drivers\SQLInterface">SQLInterface</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-SQLInterface.html"><abbr title="\Query\Drivers\SQLInterface">SQLInterface</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSystemTables">
getSystemTables()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getSystemTables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">374</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.374" class="phpdocumentor-element-found-in__source" data-line="374" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Retrieves an array of non-user-created tables for
the connection/database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSystemTables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTables">
getTables()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">307</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.307" class="phpdocumentor-element-found-in__source" data-line="307" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of tables for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_getTriggers">
getTriggers()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTriggers" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">365</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.365" class="phpdocumentor-element-found-in__source" data-line="365" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of triggers for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTriggers</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Will be removed in next version</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTypes">
getTypes()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">406</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.406" class="phpdocumentor-element-found-in__source" data-line="406" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve list of data types for the database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTypes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getUtil">
getUtil()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getUtil" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.155" class="phpdocumentor-element-found-in__source" data-line="155" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Get the Util class for the current driver</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getUtil</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-AbstractUtil.html"><abbr title="\Query\Drivers\AbstractUtil">AbstractUtil</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Query-Drivers-AbstractUtil.html"><abbr title="\Query\Drivers\AbstractUtil">AbstractUtil</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getVersion">
getVersion()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">414</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.414" class="phpdocumentor-element-found-in__source" data-line="414" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Get the version of the database engine</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<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_getViews">
getViews()
<a href="classes/Query-Drivers-AbstractDriver.html#method_getViews" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">325</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.325" class="phpdocumentor-element-found-in__source" data-line="325" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return list of views for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getViews</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|null</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_insertBatch">
insertBatch()
<a href="classes/Query-Drivers-AbstractDriver.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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">468</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.468" class="phpdocumentor-element-found-in__source" data-line="468" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Create sql for batch insert</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">array&lt;string|int, mixed&gt;</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">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_numRows">
numRows()
<a href="classes/Query-Drivers-AbstractDriver.html#method_numRows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">451</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.451" class="phpdocumentor-element-found-in__source" data-line="451" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Return the number of rows returned for a SELECT query</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">numRows</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="http://us3.php.net/manual/en/pdostatement.rowcount.php#87110"><abbr title="http://us3.php.net/manual/en/pdostatement.rowcount.php#87110">http://us3.php.net/manual/en/pdostatement.rowcount.php#87110</abbr></a></span>
</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_prefixTable">
prefixTable()
<a href="classes/Query-Drivers-AbstractDriver.html#method_prefixTable" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">219</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.219" class="phpdocumentor-element-found-in__source" data-line="219" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Prefixes a table if it is not already prefixed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prefixTable</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">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>
</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_prepareExecute">
prepareExecute()
<a href="classes/Query-Drivers-AbstractDriver.html#method_prepareExecute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">199</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.199" class="phpdocumentor-element-found-in__source" data-line="199" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Create and execute a prepared statement with the provided parameters</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prepareExecute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
</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_prepareQuery">
prepareQuery()
<a href="classes/Query-Drivers-AbstractDriver.html#method_prepareQuery" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">174</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.174" class="phpdocumentor-element-found-in__source" data-line="174" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Simplifies prepared statements for database queries</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prepareQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\PDOStatement">PDOStatement</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_quoteIdent">
quoteIdent()
<a href="classes/Query-Drivers-AbstractDriver.html#method_quoteIdent" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">257</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.257" class="phpdocumentor-element-found-in__source" data-line="257" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Surrounds the string with the databases identifier escape characters</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">quoteIdent</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$identifier</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|array&lt;string|int, mixed&gt;</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">$identifier</span>
: <span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|array&lt;string|int, mixed&gt;</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_quoteTable">
quoteTable()
<a href="classes/Query-Drivers-AbstractDriver.html#method_quoteTable" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">246</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.246" class="phpdocumentor-element-found-in__source" data-line="246" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Quote database table name, and set prefix</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">quoteTable</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">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>
</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_returning">
returning()
<a href="classes/Query-Drivers-Mysql-Driver.html#method_returning" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/Mysql/Driver.php"><a href="files/src-drivers-mysql-driver.html"><abbr title="src/Drivers/Mysql/Driver.php">Driver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.63" class="phpdocumentor-element-found-in__source" data-line="63" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Generate the returning clause for the current database</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">returning</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$query</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">$select</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">$query</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">$select</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>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setLastQuery">
setLastQuery()
<a href="classes/Query-Drivers-AbstractDriver.html#method_setLastQuery" 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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.139" class="phpdocumentor-element-found-in__source" data-line="139" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Set the last query sql</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setLastQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$queryString</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queryString</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setTablePrefix">
setTablePrefix()
<a href="classes/Query-Drivers-AbstractDriver.html#method_setTablePrefix" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">163</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.163" class="phpdocumentor-element-found-in__source" data-line="163" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Set the common table name prefix</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setTablePrefix</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$prefix</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$prefix</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_truncate">
truncate()
<a href="classes/Query-Drivers-AbstractDriver.html#method_truncate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">573</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.573" class="phpdocumentor-element-found-in__source" data-line="573" data-modal="source-view"></a>
</aside>
<p class="phpdocumentor-summary">Empty the passed table</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">truncate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$table</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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>
</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-Drivers-AbstractDriver.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/Drivers/AbstractDriver.php"><a href="files/src-drivers-abstractdriver.html"><abbr title="src/Drivers/AbstractDriver.php">AbstractDriver.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">506</span>
<a href="classes/Query-Drivers-Mysql-Driver.html#source-view.506" class="phpdocumentor-element-found-in__source" data-line="506" data-modal="source-view"></a>
</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">array&lt;string|int, mixed&gt;</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">array&lt;string|int, mixed&gt;</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/Drivers/Mysql/Driver.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-Drivers-Mysql-Driver.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 View Git Blame Copy Permalink