Module: ActionController::Cookies
- Defined in:
- lib/action_controller/cookies.rb
Overview
Cookies are read and written through ActionController#cookies.
The cookies being read are the ones received along with the request, the cookies being written will be sent out with the response. Reading a cookie does not get the cookie object itself back, just the value it holds.
Examples for writing:
# Sets a simple session cookie.
[:user_name] = "david"
# Sets a cookie that expires in 1 hour.
[:login] = { :value => "XJ-122", :expires => 1.hour.from_now }
Examples for reading:
[:user_name] # => "david"
.size # => 2
Example for deleting:
.delete :user_name
The option symbols for setting cookies are:
-
:value
- The cookie’s value or list of values (as an array). -
:path
- The path for which this cookie applies. Defaults to the root of the application. -
:domain
- The domain for which this cookie applies. -
:expires
- The time at which this cookie expires, as a Time object. -
:secure
- Whether this cookie is a only transmitted to HTTPS servers. Default isfalse
. -
:http_only
- Whether this cookie is accessible via scripting or only HTTP. Defaults tofalse
.
Class Method Summary collapse
Class Method Details
.included(base) ⇒ Object
37 38 39 |
# File 'lib/action_controller/cookies.rb', line 37 def self.included(base) base.helper_method :cookies end |