Files

Class Index [+]

Quicksearch

ActiveRecord::SessionStore::Session

The default Active Record class.

Attributes

data[W]

Public Class Methods

data_column_name click to toggle source

Customizable data column name. Defaults to ‘data’.

    # File lib/active_record/session_store.rb, line 81
81:       cattr_accessor :data_column_name
data_column_size_limit() click to toggle source
    # File lib/active_record/session_store.rb, line 88
88:         def data_column_size_limit
89:           @data_column_size_limit ||= columns_hash[data_column_name].limit
90:         end
find_by_session_id(session_id) click to toggle source

Hook to set up sessid compatibility.

    # File lib/active_record/session_store.rb, line 93
93:         def find_by_session_id(session_id)
94:           setup_sessid_compatibility!
95:           find_by_session_id(session_id)
96:         end
new(attributes = nil) click to toggle source
     # File lib/active_record/session_store.rb, line 124
124:       def initialize(attributes = nil)
125:         @data = nil
126:         super
127:       end

Private Class Methods

find_by_session_id(*args) click to toggle source
     # File lib/active_record/session_store.rb, line 108
108:               def self.find_by_session_id(*args)
109:                 find_by_sessid(*args)
110:               end
find_by_session_id(session_id) click to toggle source
     # File lib/active_record/session_store.rb, line 117
117:               def self.find_by_session_id(session_id)
118:                 find :first, :conditions => {:session_id=>session_id}
119:               end
session_id_column() click to toggle source
     # File lib/active_record/session_store.rb, line 99
 99:           def session_id_column
100:             'session_id'
101:           end
setup_sessid_compatibility!() click to toggle source

Compatibility with tables using sessid instead of session_id.

     # File lib/active_record/session_store.rb, line 104
104:           def setup_sessid_compatibility!
105:             # Reset column info since it may be stale.
106:             reset_column_information
107:             if columns_hash['sessid']
108:               def self.find_by_session_id(*args)
109:                 find_by_sessid(*args)
110:               end
111: 
112:               define_method(:session_id)  { sessid }
113:               define_method(:session_id=) { |session_id| self.sessid = session_id }
114:             else
115:               class << self; remove_method :find_by_session_id; end
116: 
117:               def self.find_by_session_id(session_id)
118:                 find :first, :conditions => {:session_id=>session_id}
119:               end
120:             end
121:           end

Public Instance Methods

data() click to toggle source

Lazy-unmarshal session state.

     # File lib/active_record/session_store.rb, line 130
130:       def data
131:         @data ||= self.class.unmarshal(read_attribute(@@data_column_name)) || {}
132:       end
loaded?() click to toggle source

Has the session been loaded yet?

     # File lib/active_record/session_store.rb, line 137
137:       def loaded?
138:         @data
139:       end

Private Instance Methods

marshal_data!() click to toggle source
     # File lib/active_record/session_store.rb, line 142
142:         def marshal_data!
143:           return false unless loaded?
144:           write_attribute(@@data_column_name, self.class.marshal(data))
145:         end
raise_on_session_data_overflow!() click to toggle source

Ensures that the data about to be stored in the database is not larger than the data storage column. Raises ActionController::SessionOverflowError.

     # File lib/active_record/session_store.rb, line 150
150:         def raise_on_session_data_overflow!
151:           return false unless loaded?
152:           limit = self.class.data_column_size_limit
153:           if limit and read_attribute(@@data_column_name).size > limit
154:             raise ActionController::SessionOverflowError
155:           end
156:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.