488 lines
12 KiB
HTML
488 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\Session | 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>
|
|
<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 class="active">
|
|
<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.Session.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.Session.html">Session</a>
|
|
</h1>
|
|
|
|
|
|
<table class="classLikeSignatureTable">
|
|
|
|
|
|
|
|
|
|
</table>
|
|
<div class="classLikeDescription">
|
|
<div class="description"><p>Class Session</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="classLikeSection">
|
|
<b>Located at</b> <a href="http://localhost\opencart-master/docs/api/source-system.library.session.html#15" title="Go to source code">system\library\session.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.session.html#29-45" title="Go to source code">__construct</a>(<span>string <var>$adaptor</var></span>, <span><a href="http://localhost\opencart-master/docs/api/Opencart.System.Engine.Registry.html"><span title="Opencart\System\Engine\Registry">Registry</span></a> <var>$registry</var></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="getId" id="_getId">
|
|
<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.session.html#47-54" title="Go to source code">getId</a>(): string</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Get Session ID</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Get Session ID</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_getId">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="start" id="_start">
|
|
<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.session.html#56-83" title="Go to source code">start</a>(<span>string <var>$session_id</var> = <span class="php-str">''</span></span>): string</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Start Starts a session.</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Start Starts a session.</p>
|
|
</div>
|
|
|
|
|
|
<h4>Returns</h4>
|
|
<div><p>returns the current session ID</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_start">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="close" id="_close">
|
|
<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.session.html#85-94" title="Go to source code">close</a>(): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Close Writes the session data to storage</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Close Writes the session data to storage</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_close">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="destroy" id="_destroy">
|
|
<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.session.html#96-107" title="Go to source code">destroy</a>(): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>Destroy Deletes the current session from storage</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>Destroy Deletes the current session from storage</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_destroy">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="gc" id="_gc">
|
|
<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.session.html#109-118" title="Go to source code">gc</a>(): void</code>
|
|
|
|
|
|
<div class="expandable-collapsedView">
|
|
<p>GC Garbage Collection</p>
|
|
|
|
</div>
|
|
|
|
<div class="expandable-expandedView">
|
|
<div class="description"><p>GC Garbage Collection</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#_gc">#</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="table" id="properties">
|
|
<tr>
|
|
<th class="table-heading sortable" colspan="4" title="Switch between natural and alphabetical order">Properties</th>
|
|
</tr>
|
|
|
|
<tr class="expandable collapsed" data-order="adaptor" id="$adaptor">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
protected
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">object</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><var><a href="http://localhost\opencart-master/docs/api/source-system.library.session.html#16-19" title="Go to source code">$adaptor</a></var></code>
|
|
|
|
|
|
<div class="expandable-expandedView">
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#$adaptor">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="session_id" id="$session_id">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
protected
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">string</code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><var><a href="http://localhost\opencart-master/docs/api/source-system.library.session.html#20-23" title="Go to source code">$session_id</a></var></code>
|
|
|
|
|
|
<div class="expandable-expandedView">
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#$session_id">#</a>
|
|
</td>
|
|
</tr>
|
|
<tr class="expandable collapsed" data-order="data" id="$data">
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="table-cell table-shrink">
|
|
<code class="nowrap">array<mixed></code>
|
|
</td>
|
|
|
|
<td class="table-cell">
|
|
<code><var><a href="http://localhost\opencart-master/docs/api/source-system.library.session.html#24-27" title="Go to source code">$data</a></var> = []</code>
|
|
|
|
|
|
<div class="expandable-expandedView">
|
|
</div>
|
|
</td>
|
|
<td class="table-anchor">
|
|
<a href="#$data">#</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>
|