<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The SessionHandlerInterface class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sessionhandler.write.html">SessionHandler::write</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sessionhandlerinterface.close.html">SessionHandlerInterface::close</a></div>
<div class="up"><a href="book.session.html">Sessions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.sessionhandlerinterface" class="reference">
<h1 class="title">The SessionHandlerInterface class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.4.0)</p>
<div class="section" id="sessionhandlerinterface.intro">
<h2 class="title">Introduction</h2>
<p class="para">
<strong class="classname">SessionHandlerInterface</strong> is an
<a href="language.oop5.interfaces.html" class="link">interface</a> which defines a
prototype for creating a custom session handler. In order to pass a custom
session handler to <span class="function"><a href="function.session-set-save-handler.html" class="function">session_set_save_handler()</a></span> using its
<em>OOP</em> invocation, the class must implement this interface.
</p>
<p class="para">
Please note the callback methods of this class are designed to be called internally by
PHP and are not meant to be called from user-space code.
</p>
</div>
<div class="section" id="sessionhandlerinterface.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SessionHandlerInterface</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="sessionhandlerinterface.close.html" class="methodname">close</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="sessionhandlerinterface.destroy.html" class="methodname">destroy</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$session_id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="sessionhandlerinterface.gc.html" class="methodname">gc</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$maxlifetime</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="sessionhandlerinterface.open.html" class="methodname">open</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$save_path</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="sessionhandlerinterface.read.html" class="methodname">read</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$session_id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="sessionhandlerinterface.write.html" class="methodname">write</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$session_id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$session_data</code></span>
)</div>
}</div>
</div>
<div class="section" id="sessionhandlerinterface.examples">
<div class="example" id="example-4775">
<p><strong>Example #1
Example using <strong class="classname">SessionHandlerInterface</strong>
</strong></p>
<div class="example-contents"><p>
The following example provides file based session storage similar to the
PHP sessions default save handler <em><code class="parameter">files</code></em>. This
example could easily be extended to cover database storage using your
favorite PHP supported database engine.
</p></div>
<div class="example-contents"><p>
Note we use the OOP prototype with <span class="function"><a href="function.session-set-save-handler.html" class="function">session_set_save_handler()</a></span> and
register the shutdown function using the function's parameter flag. This is generally
advised when registering objects as session save handlers.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MySessionHandler </span><span style="color: #007700">implements </span><span style="color: #0000BB">SessionHandlerInterface<br /></span><span style="color: #007700">{<br /> private </span><span style="color: #0000BB">$savePath</span><span style="color: #007700">;<br /><br /> public function </span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$savePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$sessionName</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath </span><span style="color: #007700">= </span><span style="color: #0000BB">$savePath</span><span style="color: #007700">;<br /> if (!</span><span style="color: #0000BB">is_dir</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">mkdir</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #007700">, </span><span style="color: #0000BB">0777</span><span style="color: #007700">);<br /> }<br /><br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br /> public function </span><span style="color: #0000BB">close</span><span style="color: #007700">()<br /> {<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br /> public function </span><span style="color: #0000BB">read</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">)<br /> {<br /> return (string)@</span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #DD0000">/sess_</span><span style="color: #0000BB">$id</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /> }<br /><br /> public function </span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">)<br /> {<br /> return </span><span style="color: #0000BB">file_put_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #DD0000">/sess_</span><span style="color: #0000BB">$id</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">) === </span><span style="color: #0000BB">false </span><span style="color: #007700">? </span><span style="color: #0000BB">false </span><span style="color: #007700">: </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br /> public function </span><span style="color: #0000BB">destroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #DD0000">/sess_</span><span style="color: #0000BB">$id</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br /> }<br /><br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br /> public function </span><span style="color: #0000BB">gc</span><span style="color: #007700">(</span><span style="color: #0000BB">$maxlifetime</span><span style="color: #007700">)<br /> {<br /> foreach (</span><span style="color: #0000BB">glob</span><span style="color: #007700">(</span><span style="color: #DD0000">"</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">savePath</span><span style="color: #DD0000">/sess_*"</span><span style="color: #007700">) as </span><span style="color: #0000BB">$file</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">filemtime</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">) + </span><span style="color: #0000BB">$maxlifetime </span><span style="color: #007700">< </span><span style="color: #0000BB">time</span><span style="color: #007700">() && </span><span style="color: #0000BB">file_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br /> }<br /> }<br /><br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$handler </span><span style="color: #007700">= new </span><span style="color: #0000BB">MySessionHandler</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">session_set_save_handler</span><span style="color: #007700">(</span><span style="color: #0000BB">$handler</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// proceed to set and retrieve values by key from $_SESSION</span>
</span>
</code></div>
</div>
</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="sessionhandlerinterface.close.html">SessionHandlerInterface::close</a> — Close the session</li><li><a href="sessionhandlerinterface.destroy.html">SessionHandlerInterface::destroy</a> — Destroy a session</li><li><a href="sessionhandlerinterface.gc.html">SessionHandlerInterface::gc</a> — Cleanup old sessions</li><li><a href="sessionhandlerinterface.open.html">SessionHandlerInterface::open</a> — Initialize session</li><li><a href="sessionhandlerinterface.read.html">SessionHandlerInterface::read</a> — Read session data</li><li><a href="sessionhandlerinterface.write.html">SessionHandlerInterface::write</a> — Write session data</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sessionhandler.write.html">SessionHandler::write</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sessionhandlerinterface.close.html">SessionHandlerInterface::close</a></div>
<div class="up"><a href="book.session.html">Sessions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
