opencart/docs/api/Opencart.System.Library.DB.html
2024-03-04 23:29:14 +08:00

442 lines
12 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Class Opencart\System\Library\DB | OpenCart API API</title>
<link rel="stylesheet" href="http://localhost\opencart-master/docs/api/assets/main.css">
<script src="http://localhost\opencart-master/docs/api/assets/main.js" defer></script>
</head>
<body class="layout">
<div class="layout-aside">
<div class="menu">
<div class="menu-section">
<h3>Namespaces</h3>
<ul>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Admin.html">Admin</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.Catalog.html">Catalog</a>
</li>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Engine.html">Engine</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Helper.html">Helper</a>
</li>
<li class="menuGroup-item active">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Library</a>
<ul>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Cache.html">Cache</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Cart.html">Cart</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.DB.html">DB</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Mail.html">Mail</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Session.html">Session</a>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.Template.html">Template</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="menuGroup-item">
<a href="http://localhost\opencart-master/docs/api/namespace-none.html">none</a>
</li>
</ul>
</div>
<div class="menu-section">
<h3>Classes</h3>
<ul>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Cache.html">
Cache
</a>
</li>
<li class="active">
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.DB.html">
DB
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Document.html">
Document
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Image.html">
Image
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Language.html">
Language
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Log.html">
Log
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Mail.html">
Mail
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Request.html">
Request
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Response.html">
Response
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Session.html">
Session
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Template.html">
Template
</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.Url.html">
Url
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="layout-main">
<div class="layout-navbar">
<nav class="navbar">
<div class="navbar-left">
<ul class="navbar-links">
<li>
<a href="http://localhost\opencart-master/docs/api/index.html">Overview</a>
</li>
<li>
<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Namespace</a>
</li>
<li class="active"><a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.DB.html">Class</a></li> <li>
<a href="http://localhost\opencart-master/docs/api/tree.html">Tree</a>
</li>
</ul>
</div>
<div class="navbar-right">
<div class="search" data-elements="http://localhost\opencart-master/docs/api/assets/elements.js">
<input class="search-input" placeholder="Search class, function or namespace" autofocus>
<ul class="search-results"></ul>
</div>
</div>
</nav>
</div>
<div class="layout-content">
<h1>
Class <a href="http://localhost\opencart-master/docs/api/namespace-Opencart.html">Opencart</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.html">System</a>\<a href="http://localhost\opencart-master/docs/api/namespace-Opencart.System.Library.html">Library</a>\<a href="http://localhost\opencart-master/docs/api/Opencart.System.Library.DB.html">DB</a>
</h1>
<table class="classLikeSignatureTable">
</table>
<div class="classLikeDescription">
<div class="description"><p>Class DB Adaptor</p>
</div>
</div>
<div class="classLikeSection">
<b>Located at</b> <a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#17" title="Go to source code">system\library\db.php</a><br>
</div>
<table class="table" id="methods">
<tr>
<th class="table-heading sortable" colspan="3" title="Switch between natural and alphabetical order">Methods</th>
</tr>
<tr class="expandable collapsed" data-order="__construct" id="___construct">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#23-44" title="Go to source code">__construct</a>(
<span>string <var>$adaptor</var></span>,
<span>string <var>$hostname</var></span>,
<span>string <var>$username</var></span>,
<span>string <var>$password</var></span>,
<span>string <var>$database</var></span>,
<span>string <var>$port</var> = <span class="php-str">''</span></span>,
<span>string <var>$ssl_key</var> = <span class="php-str">''</span></span>,
<span>string <var>$ssl_cert</var> = <span class="php-str">''</span></span>,
<span>string <var>$ssl_ca</var> = <span class="php-str">''</span></span>,
)</code>
<div class="expandable-collapsedView">
<p>Constructor</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Constructor</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#___construct">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="query" id="_query">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#46-55" title="Go to source code">query</a>(<span>string <var>$sql</var></span>): mixed</code>
<div class="expandable-collapsedView">
<p>Query</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Query</p>
</div>
<h4>Parameters</h4>
<table>
<tr>
<td><var>$sql</var>&nbsp;&nbsp;</td>
<td><p>SQL statement to be executed</p>
</td>
</tr>
</table>
</div>
</td>
<td class="table-anchor">
<a href="#_query">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="escape" id="_escape">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#57-66" title="Go to source code">escape</a>(<span>string <var>$value</var></span>): string</code>
<div class="expandable-collapsedView">
<p>Escape</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>Escape</p>
</div>
<h4>Parameters</h4>
<table>
<tr>
<td><var>$value</var>&nbsp;&nbsp;</td>
<td><p>Value to be protected against SQL injections</p>
</td>
</tr>
</table>
<h4>Returns</h4>
<div><p>Returns escaped value</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_escape">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="countAffected" id="_countAffected">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#68-77" title="Go to source code">countAffected</a>(): int</code>
<div class="expandable-collapsedView">
<p>countAffected Gets the total number of affected rows from the last query</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>countAffected Gets the total number of affected rows from the last query</p>
</div>
<h4>Returns</h4>
<div><p>returns the total number of affected rows</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_countAffected">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="getLastId" id="_getLastId">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#79-88" title="Go to source code">getLastId</a>(): int</code>
<div class="expandable-collapsedView">
<p>getLastId Get the last ID gets the primary key that was returned after creating a row in a table.</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>getLastId Get the last ID gets the primary key that was returned after creating a row in a table.</p>
</div>
<h4>Returns</h4>
<div><p>Returns last ID</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_getLastId">#</a>
</td>
</tr>
<tr class="expandable collapsed" data-order="isConnected" id="_isConnected">
<td class="table-cell table-shrink">
<code class="nowrap">
public
</code>
</td>
<td class="table-cell">
<code><a href="http://localhost\opencart-master/docs/api/source-system.library.db.html#90-99" title="Go to source code">isConnected</a>(): bool</code>
<div class="expandable-collapsedView">
<p>isConnected Checks if a DB connection is active.</p>
</div>
<div class="expandable-expandedView">
<div class="description"><p>isConnected Checks if a DB connection is active.</p>
</div>
</div>
</td>
<td class="table-anchor">
<a href="#_isConnected">#</a>
</td>
</tr>
</table>
</div>
<div class="layout-footer">
OpenCart API API documentation generated by <a href="https://www.apigen.org">ApiGen dev-master</a>
</div>
</div>
<div class="layout-rest">
<div class="navbar"></div>
</div>
</body>
</html>