phpdoc/Library/Session/Session.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Library\Session\Session | Library</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Library_Session_Session" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Library</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../Library.html">Library</a></li>
<li><a href="../../Library/Session.html">Session</a></li>
<li>Session</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Session</h1>
</div>
<p> class
<strong>Session</strong> implements
<a href="../../Library/Session/SessionInterface.html"><abbr title="Library\Session\SessionInterface">SessionInterface</abbr></a>
</p>
<div class="description">
<p>Session manager class</p> </div>
<h2>Constants</h2>
<table class="table table-condensed">
<tr>
<td>SESSION_NAME</td>
<td class="last">
<p><em>The session attributes application stack</em></p>
<p>
</p>
</td>
</tr>
<tr>
<td>SESSION_ATTRIBUTESNAME</td>
<td class="last">
<p><em>The session attributes stack</em></p>
<p>
</p>
</td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>()
<p>Constructor</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___destruct">__destruct</a>()
<p>Automatically store new entries at object destruction</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_addSessionTable">addSessionTable</a>(
string $index,
mixed $value)
<p>Add a session table entry</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getSessionTable">getSessionTable</a>()
<p>Get the full session table</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getId">getId</a>()
<p>Get current session ID</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getName">getName</a>()
<p>Get current session name</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_isOpened">isOpened</a>()
<p>Test if the current session is already started</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_isLoaded">isLoaded</a>()
<p>Test if the current session is already loaded</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_start">start</a>()
<p>Start the current session and read it</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_open">open</a>()
<p>Open the current session</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_close">close</a>()
<p>Close the current session</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_read">read</a>()
<p>Read the current session contents</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_commit">commit</a>()
<p>Save current session</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_clear">clear</a>()
<p>Destroy current session</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_regenerateId">regenerateId</a>()
<p>Regenrate current session ID</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getAttributes">getAttributes</a>()
<p>Get all current session values</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_has">has</a>(
string $param)
<p>Test if the current session has a parameter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_get">get</a>(
string $param)
<p>Get current session parameter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_set">set</a>(
string $param,
mixed $value)
<p>Set current session parameter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_remove">remove</a>(
string $param)
<p>Delete a session parameter</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_getBackup">getBackup</a>(
string $param)
<p>Get an initial session value</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 75</div>
<code>
<strong>__construct</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Constructor</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___destruct">
<div class="location">at line 87</div>
<code>
<strong>__destruct</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Automatically store new entries at object destruction</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_addSessionTable">
<div class="location">at line 105</div>
<code>
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a>
<strong>addSessionTable</strong>(
string $index,
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Add a session table entry</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$index</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getSessionTable">
<div class="location">at line 116</div>
<code>
array
<strong>getSessionTable</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the full session table</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getId">
<div class="location">at line 126</div>
<code>
string
<strong>getId</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get current session ID</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getName">
<div class="location">at line 139</div>
<code>
string
<strong>getName</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get current session name</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isOpened">
<div class="location">at line 149</div>
<code>
bool
<strong>isOpened</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if the current session is already started</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isLoaded">
<div class="location">at line 159</div>
<code>
bool
<strong>isLoaded</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if the current session is already loaded</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_start">
<div class="location">at line 173</div>
<code>
<strong>start</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Start the current session and read it</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_open">
<div class="location">at line 189</div>
<code>
<strong>open</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Open the current session</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_close">
<div class="location">at line 207</div>
<code>
<strong>close</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Close the current session</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_read">
<div class="location">at line 225</div>
<code>
<strong>read</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Read the current session contents</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_commit">
<div class="location">at line 243</div>
<code>
<strong>commit</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Save current session</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_clear">
<div class="location">at line 258</div>
<code>
<strong>clear</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Destroy current session</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_regenerateId">
<div class="location">at line 273</div>
<code>
<strong>regenerateId</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Regenrate current session ID</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getAttributes">
<div class="location">at line 287</div>
<code>
array
<strong>getAttributes</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get all current session values</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_has">
<div class="location">at line 301</div>
<code>
bool
<strong>has</strong>(
string $param)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if the current session has a parameter</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$param</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_get">
<div class="location">at line 315</div>
<code>
mixed
<strong>get</strong>(
string $param)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get current session parameter</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$param</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_set">
<div class="location">at line 330</div>
<code>
<strong>set</strong>(
string $param,
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set current session parameter</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$param</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_remove">
<div class="location">at line 345</div>
<code>
<strong>remove</strong>(
string $param)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Delete a session parameter</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$param</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getBackup">
<div class="location">at line 362</div>
<code>
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a>
<strong>getBackup</strong>(
string $param)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get an initial session value</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$param</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../Library/Session/Session.html"><abbr title="Library\Session\Session">Session</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>