548 lines
11 KiB
HTML
548 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="ApiGen 2.8.0" />
|
|
|
|
<title>Class Slim\Middleware\SessionCookie | GeoApi</title>
|
|
|
|
<script type="text/javascript" src="resources/combined.js?112270826"></script>
|
|
<script type="text/javascript" src="elementlist.js?4049399837"></script>
|
|
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div id="left">
|
|
<div id="menu">
|
|
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
|
|
|
|
<div id="groups">
|
|
<h3>Namespaces</h3>
|
|
<ul>
|
|
<li><a href="namespace-api.html">api</a>
|
|
</li>
|
|
<li><a href="namespace-config.html">config</a>
|
|
</li>
|
|
<li><a href="namespace-database.html">database</a>
|
|
</li>
|
|
<li><a href="namespace-PHP.html">PHP</a>
|
|
</li>
|
|
<li class="active"><a href="namespace-Slim.html">Slim<span></span></a>
|
|
<ul>
|
|
<li><a href="namespace-Slim.Exception.html">Exception</a>
|
|
</li>
|
|
<li><a href="namespace-Slim.Http.html">Http</a>
|
|
</li>
|
|
<li class="active"><a href="namespace-Slim.Middleware.html">Middleware</a>
|
|
</li>
|
|
</ul></li>
|
|
<li><a href="namespace-utiliy.html">utiliy</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
|
|
<div id="elements">
|
|
<h3>Classes</h3>
|
|
<ul>
|
|
<li><a href="class-Slim.Middleware.ContentTypes.html">ContentTypes</a></li>
|
|
<li><a href="class-Slim.Middleware.Flash.html">Flash</a></li>
|
|
<li><a href="class-Slim.Middleware.MethodOverride.html">MethodOverride</a></li>
|
|
<li><a href="class-Slim.Middleware.PrettyExceptions.html">PrettyExceptions</a></li>
|
|
<li class="active"><a href="class-Slim.Middleware.SessionCookie.html">SessionCookie</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="splitter"></div>
|
|
|
|
<div id="right">
|
|
<div id="rightInner">
|
|
<form id="search">
|
|
<input type="hidden" name="cx" value="" />
|
|
<input type="hidden" name="ie" value="UTF-8" />
|
|
<input type="text" name="q" class="text" />
|
|
<input type="submit" value="Search" />
|
|
</form>
|
|
|
|
<div id="navigation">
|
|
<ul>
|
|
<li>
|
|
<a href="index.html" title="Overview"><span>Overview</span></a>
|
|
</li>
|
|
<li>
|
|
<a href="namespace-Slim.Middleware.html" title="Summary of Slim\Middleware"><span>Namespace</span></a>
|
|
</li>
|
|
<li class="active">
|
|
<span>Class</span> </li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="content" class="class">
|
|
<h1>Class SessionCookie</h1>
|
|
|
|
|
|
<div class="description">
|
|
|
|
<p>Session Cookie</p>
|
|
|
|
<p>This class provides an HTTP cookie storage mechanism for session data. This
|
|
class avoids using a PHP session and instead serializes/unserializes the
|
|
$_SESSION global variable to/from an HTTP cookie.</p>
|
|
|
|
<p>If a secret key is provided with this middleware, the HTTP cookie will be
|
|
checked for integrity to ensure the client-side cookie is not changed.</p>
|
|
|
|
<p>You should NEVER store sensitive data in a client-side cookie in any format,
|
|
encrypted or not. If you need to store sensitive user information in a session,
|
|
you should rely on PHP's native session implementation, or use other middleware
|
|
to store session data in a database or alternative server-side cache.</p>
|
|
|
|
<p>Because this class stores serialized session data in an HTTP cookie, you are
|
|
inherently limtied to 4 Kb. If you attempt to store more than this amount,
|
|
serialization will fail.</p>
|
|
|
|
</div>
|
|
|
|
<dl class="tree">
|
|
<dd style="padding-left:0px">
|
|
<a href="class-Slim.Middleware.html"><span>Slim\Middleware</span></a>
|
|
|
|
|
|
|
|
</dd>
|
|
<dd style="padding-left:30px">
|
|
<img src="resources/inherit.png" alt="Extended by" />
|
|
<b><span>Slim\Middleware\SessionCookie</span></b>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="info">
|
|
|
|
|
|
<b>Namespace:</b> <a href="namespace-Slim.html">Slim</a>\<a href="namespace-Slim.Middleware.html">Middleware</a><br />
|
|
<b>Package:</b> Slim<br />
|
|
|
|
<b>Author:</b>
|
|
Josh Lockhart<br />
|
|
<b>Since:</b>
|
|
1.6.0<br />
|
|
<b>Located at</b> <a href="source-class-Slim.Middleware.SessionCookie.html#35-203" title="Go to source code">thirdparty/Slim/Middleware/SessionCookie.php</a><br />
|
|
</div>
|
|
|
|
|
|
|
|
<table class="summary" id="methods">
|
|
<caption>Methods summary</caption>
|
|
<tr data-order="__construct" id="___construct">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#___construct">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#68-108" title="Go to source code">__construct</a>( <span>array <var>$settings</var> = <span class="php-keyword1">array</span>()</span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Constructor</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Constructor</p>
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
<div class="list"><dl>
|
|
<dt><var>$settings</var></dt>
|
|
<dd><code>array</code><br>$settings</dd>
|
|
</dl></div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="call" id="_call">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_call">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#110-118" title="Go to source code">call</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Call</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Call</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="loadSession" id="_loadSession">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_loadSession">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#120-141" title="Go to source code">loadSession</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Load session</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Load session</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="saveSession" id="_saveSession">
|
|
|
|
<td class="attributes"><code>
|
|
protected
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_saveSession">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#143-168" title="Go to source code">saveSession</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
<p>Save session</p>
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
<p>Save session</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="open" id="_open">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_open">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#174-177" title="Go to source code">open</a>( <span>mixed <var>$savePath</var></span>, <span>mixed <var>$sessionName</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="close" id="_close">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_close">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#179-182" title="Go to source code">close</a>( )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="read" id="_read">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_read">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#184-187" title="Go to source code">read</a>( <span>mixed <var>$id</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="write" id="_write">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_write">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#189-192" title="Go to source code">write</a>( <span>mixed <var>$id</var></span>, <span>mixed <var>$data</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="destroy" id="_destroy">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_destroy">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#194-197" title="Go to source code">destroy</a>( <span>mixed <var>$id</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
<tr data-order="gc" id="_gc">
|
|
|
|
<td class="attributes"><code>
|
|
public
|
|
|
|
|
|
</code>
|
|
</td>
|
|
|
|
<td class="name"><div>
|
|
<a class="anchor" href="#_gc">#</a>
|
|
<code><a href="source-class-Slim.Middleware.SessionCookie.html#199-202" title="Go to source code">gc</a>( <span>mixed <var>$maxlifetime</var></span> )</code>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="summary inherited">
|
|
<caption>Methods inherited from <a href="class-Slim.Middleware.html#methods">Slim\Middleware</a></caption>
|
|
<tr>
|
|
<td><code>
|
|
<a href="class-Slim.Middleware.html#_getApplication">getApplication()</a>,
|
|
<a href="class-Slim.Middleware.html#_getNextMiddleware">getNextMiddleware()</a>,
|
|
<a href="class-Slim.Middleware.html#_setApplication">setApplication()</a>,
|
|
<a href="class-Slim.Middleware.html#_setNextMiddleware">setNextMiddleware()</a>
|
|
</code></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties">
|
|
<caption>Properties summary</caption>
|
|
<tr data-order="settings" id="$settings">
|
|
<td class="attributes"><code>
|
|
protected
|
|
array
|
|
</code></td>
|
|
|
|
<td class="name">
|
|
<a href="source-class-Slim.Middleware.SessionCookie.html#63-66" title="Go to source code"><var>$settings</var></a>
|
|
</td>
|
|
<td class="value"><code></code></td>
|
|
<td class="description"><div>
|
|
<a href="#$settings" class="anchor">#</a>
|
|
|
|
<div class="description short">
|
|
|
|
</div>
|
|
|
|
<div class="description detailed hidden">
|
|
|
|
|
|
</div>
|
|
</div></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table class="summary inherited">
|
|
<caption>Properties inherited from <a href="class-Slim.Middleware.html#properties">Slim\Middleware</a></caption>
|
|
<tr>
|
|
<td><code>
|
|
<a href="class-Slim.Middleware.html#$app"><var>$app</var></a>,
|
|
<a href="class-Slim.Middleware.html#$next"><var>$next</var></a>
|
|
</code></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
GeoApi API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|