Module: ActionController::SessionManagement::ClassMethods
- Defined in:
- lib/action_controller/session_management.rb
Instance Method Summary collapse
-
#cached_session_options ⇒ Object
:nodoc:.
-
#session(*args) ⇒ Object
(also: #session=)
Specify how sessions ought to be managed for a subset of the actions on the controller.
-
#session_options ⇒ Object
Returns the hash used to configure the session.
-
#session_options_for(request, action) ⇒ Object
:nodoc:.
-
#session_store ⇒ Object
Returns the session store class currently used.
-
#session_store=(store) ⇒ Object
Set the session store to be used for keeping the session data between requests.
Instance Method Details
#cached_session_options ⇒ Object
:nodoc:
95 96 97 |
# File 'lib/action_controller/session_management.rb', line 95 def #:nodoc: @session_options ||= read_inheritable_attribute("session_options") || [] end |
#session(*args) ⇒ Object Also known as: session=
Specify how sessions ought to be managed for a subset of the actions on the controller. Like filters, you can specify :only
and :except
clauses to restrict the subset, otherwise options apply to all actions on this controller.
The session options are inheritable, as well, so if you specify them in a parent controller, they apply to controllers that extend the parent.
Usage:
# turn off session management for all actions.
session :off
# turn off session management for all actions _except_ foo and bar.
session :off, :except => %w(foo bar)
# turn off session management for only the foo and bar actions.
session :off, :only => %w(foo bar)
# the session will only work over HTTPS, but only for the foo action
session :only => :foo, :session_secure => true
# the session will only be disabled for 'foo', and only if it is
# requested as a web service
session :off, :only => :foo,
:if => Proc.new { |req| req.parameters[:ws] }
# the session will be disabled for non html/ajax requests
session :off,
:if => Proc.new { |req| !(req.format.html? || req.format.js?) }
# turn the session back on, useful when it was turned off in the
# application controller, and you need it on in another controller
session :on
All session options described for ActionController::Base.process_cgi are valid arguments.
78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/action_controller/session_management.rb', line 78 def session(*args) = args. [:disabled] = false if args.delete(:on) [:disabled] = true if !args.empty? [:only] = [*[:only]].map { |o| o.to_s } if [:only] [:except] = [*[:except]].map { |o| o.to_s } if [:except] if [:only] && [:except] raise ArgumentError, "only one of either :only or :except are allowed" end write_inheritable_array("session_options", []) end |
#session_options ⇒ Object
Returns the hash used to configure the session. Example use:
ActionController::Base.[:session_secure] = true # session only available over HTTPS
37 38 39 |
# File 'lib/action_controller/session_management.rb', line 37 def ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS end |
#session_options_for(request, action) ⇒ Object
:nodoc:
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/action_controller/session_management.rb', line 99 def (request, action) #:nodoc: if ( = ).empty? {} else = {} action = action.to_s .each do |opts| next if opts[:if] && !opts[:if].call(request) if opts[:only] && opts[:only].include?(action) .merge!(opts) elsif opts[:except] && !opts[:except].include?(action) .merge!(opts) elsif !opts[:only] && !opts[:except] .merge!(opts) end end if .empty? then else .delete :only .delete :except .delete :if [:disabled] ? false : end end end |
#session_store ⇒ Object
Returns the session store class currently used.
30 31 32 |
# File 'lib/action_controller/session_management.rb', line 30 def session_store ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS[:database_manager] end |
#session_store=(store) ⇒ Object
Set the session store to be used for keeping the session data between requests. By default, sessions are stored in browser cookies (:cookie_store
), but you can also specify one of the other included stores (:active_record_store
, :p_store
, :drb_store
, :mem_cache_store
, or :memory_store
) or your own custom class.
24 25 26 27 |
# File 'lib/action_controller/session_management.rb', line 24 def session_store=(store) ActionController::CgiRequest::DEFAULT_SESSION_OPTIONS[:database_manager] = store.is_a?(Symbol) ? CGI::Session.const_get(store == :drb_store ? "DRbStore" : store.to_s.camelize) : store end |