File: C:/Ruby27-x64/share/doc/ruby/html/CGI/Session/PStore.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class CGI::Session::PStore - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-restore">#restore</a>
<li ><a href="#method-i-update">#update</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-CGI::Session::PStore">
<h1 id="class-CGI::Session::PStore" class="class">
class CGI::Session::PStore
</h1>
<section class="description">
<p>PStore-based session storage class.</p>
<p>This builds upon the top-level <a href="PStore.html"><code>PStore</code></a> class provided by the library file pstore.rb. <a href="../Session.html"><code>Session</code></a> data is marshalled and stored in a file. <a href="../../File.html"><code>File</code></a> locking and transaction services are provided.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(session, option={})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="PStore.html"><code>CGI::Session::PStore</code></a> instance</p>
<p>This constructor is used internally by <a href="../Session.html"><code>CGI::Session</code></a>. The user does not generally need to call it directly.</p>
<p><code>session</code> is the session for which this instance is being created. The session id must only contain alphanumeric characters; automatically generated session ids observe this requirement.</p>
<p><code>option</code> is a hash of options for the initializer. The following options are recognised:</p>
<dl class="rdoc-list note-list"><dt>tmpdir
<dd>
<p>the directory to use for storing the <a href="PStore.html"><code>PStore</code></a> file. Defaults to <a href="../../Dir.html#method-c-tmpdir"><code>Dir::tmpdir</code></a> (generally “/tmp” on Unix systems).</p>
</dd><dt>prefix
<dd>
<p>the prefix to add to the session id when generating the filename for this session's <a href="PStore.html"><code>PStore</code></a> file. Defaults to the empty string.</p>
</dd></dl>
<p>This session's <a href="PStore.html"><code>PStore</code></a> file will be created if it does not exist, or opened if it does.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/cgi/session/pstore.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">session</span>, <span class="ruby-identifier">option</span>={})
<span class="ruby-identifier">dir</span> = <span class="ruby-identifier">option</span>[<span class="ruby-string">'tmpdir'</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Dir</span><span class="ruby-operator">::</span><span class="ruby-identifier">tmpdir</span>
<span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">option</span>[<span class="ruby-string">'prefix'</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>
<span class="ruby-identifier">id</span> = <span class="ruby-identifier">session</span>.<span class="ruby-identifier">session_id</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'digest/md5'</span>
<span class="ruby-identifier">md5</span> = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">id</span>)[<span class="ruby-value">0</span>,<span class="ruby-value">16</span>]
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">dir</span><span class="ruby-string">+"/"</span><span class="ruby-operator">+</span><span class="ruby-identifier">prefix</span><span class="ruby-operator">+</span><span class="ruby-identifier">md5</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-ivar">@hash</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">session</span>.<span class="ruby-identifier">new_session</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-constant">Session</span><span class="ruby-operator">::</span><span class="ruby-constant">NoSession</span>, <span class="ruby-string">"uninitialized session"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@hash</span> = {}
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@p</span> = <span class="ruby-operator">::</span><span class="ruby-constant">PStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-ivar">@p</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">chmod</span>(<span class="ruby-value">0600</span>, <span class="ruby-identifier">p</span>.<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Update and close the session's <a href="PStore.html"><code>PStore</code></a> file.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/cgi/session/pstore.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-identifier">update</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Close and delete the session's <a href="PStore.html"><code>PStore</code></a> file.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/cgi/session/pstore.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>
<span class="ruby-identifier">path</span> = <span class="ruby-ivar">@p</span>.<span class="ruby-identifier">path</span>
<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">unlink</span> <span class="ruby-identifier">path</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-restore" class="method-detail ">
<div class="method-heading">
<span class="method-name">restore</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Restore session state from the session's <a href="PStore.html"><code>PStore</code></a> file.</p>
<p>Returns the session state as a hash.</p>
<div class="method-source-code" id="restore-source">
<pre><span class="ruby-comment"># File lib/cgi/session/pstore.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">restore</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@hash</span>
<span class="ruby-ivar">@p</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@hash</span> = <span class="ruby-ivar">@p</span>[<span class="ruby-string">'hash'</span>] <span class="ruby-operator">||</span> {}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@hash</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-update" class="method-detail ">
<div class="method-heading">
<span class="method-name">update</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Save session state to the session's <a href="PStore.html"><code>PStore</code></a> file.</p>
<div class="method-source-code" id="update-source">
<pre><span class="ruby-comment"># File lib/cgi/session/pstore.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update</span>
<span class="ruby-ivar">@p</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@p</span>[<span class="ruby-string">'hash'</span>] = <span class="ruby-ivar">@hash</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>