<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: ActiveRecord::SessionStore::SqlBypass</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">ActiveRecord::SessionStore::SqlBypass</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/active_record/session_store_rb.html">
lib/active_record/session_store.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
A barebones session store which duck-types with the default session store
but bypasses Active Record and issues SQL directly. This is an example
session model class meant as a basis for your own classes.
</p>
<p>
The database <a href="SqlBypass.html#M000426">connection</a>, table name,
and session id and <a href="SqlBypass.html#M000434">data</a> columns are
configurable class attributes. Marshaling and unmarshaling are implemented
as class methods that you may override. By default, marshaling <a
href="SqlBypass.html#M000434">data</a> is
</p>
<pre>
ActiveSupport::Base64.encode64(Marshal.dump(data))
</pre>
<p>
and unmarshaling <a href="SqlBypass.html#M000434">data</a> is
</p>
<pre>
Marshal.load(ActiveSupport::Base64.decode64(data))
</pre>
<p>
This marshaling behavior is intended to store the widest range of binary
session <a href="SqlBypass.html#M000434">data</a> in a <tt>text</tt>
column. For higher performance, store in a <tt>blob</tt> column instead and
forgo the Base64 encoding.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000426">connection</a>
<a href="#M000430">create_table!</a>
<a href="#M000434">data</a>
<a href="#M000437">destroy</a>
<a href="#M000431">drop_table!</a>
<a href="#M000427">find_by_session_id</a>
<a href="#M000435">loaded?</a>
<a href="#M000428">marshal</a>
<a href="#M000432">new</a>
<a href="#M000433">new_record?</a>
<a href="#M000436">save</a>
<a href="#M000429">unmarshal</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">data</td>
<td class="context-item-value"> [W] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">session_id</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000426" class="method-detail">
<a name="M000426"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000426.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000426.html');return false;">
<span class="method-name">connection</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000430" class="method-detail">
<a name="M000430"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000430.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000430.html');return false;">
<span class="method-name">create_table!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000431" class="method-detail">
<a name="M000431"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000431.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000431.html');return false;">
<span class="method-name">drop_table!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000427" class="method-detail">
<a name="M000427"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000427.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000427.html');return false;">
<span class="method-name">find_by_session_id</span><span class="method-args">(session_id)</span>
</a>
</div>
<div class="method-description">
<p>
Look up a session by id and <a href="SqlBypass.html#M000429">unmarshal</a>
its <a href="SqlBypass.html#M000434">data</a> if found.
</p>
</div>
</div>
<div id="method-M000428" class="method-detail">
<a name="M000428"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000428.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000428.html');return false;">
<span class="method-name">marshal</span><span class="method-args">(data)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000432" class="method-detail">
<a name="M000432"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000432.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000432.html');return false;">
<span class="method-name">new</span><span class="method-args">(attributes)</span>
</a>
</div>
<div class="method-description">
<p>
Look for normal and marshaled <a href="SqlBypass.html#M000434">data</a>,
self.find_by_session_id‘s way of telling us to postpone unmarshaling
until the <a href="SqlBypass.html#M000434">data</a> is requested. We need
to handle a normal <a href="SqlBypass.html#M000434">data</a> attribute in
case of a <a href="SqlBypass.html#M000432">new</a> record.
</p>
</div>
</div>
<div id="method-M000429" class="method-detail">
<a name="M000429"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000429.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000429.html');return false;">
<span class="method-name">unmarshal</span><span class="method-args">(data)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000434" class="method-detail">
<a name="M000434"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000434.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000434.html');return false;">
<span class="method-name">data</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Lazy-<a href="SqlBypass.html#M000429">unmarshal</a> session state.
</p>
</div>
</div>
<div id="method-M000437" class="method-detail">
<a name="M000437"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000437.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000437.html');return false;">
<span class="method-name">destroy</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000435" class="method-detail">
<a name="M000435"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000435.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000435.html');return false;">
<span class="method-name">loaded?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000433" class="method-detail">
<a name="M000433"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000433.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000433.html');return false;">
<span class="method-name">new_record?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000436" class="method-detail">
<a name="M000436"></a>
<div class="method-heading">
<a href="SqlBypass.src/M000436.html" target="Code" class="method-signature"
onclick="popupCode('SqlBypass.src/M000436.html');return false;">
<span class="method-name">save</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d51872cc0e1fdee944d71993f94ac764
>
files
>
726
