Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

expand cookie examples with signed and permanent methods

  • Loading branch information...
commit 6c84fd80b71db56a25548028c7d079d8a72e44c0 1 parent c144f50
Joost Baaij tilsammans authored fxn committed
Showing with 11 additions and 2 deletions.
  1. +11 −2 actionpack/lib/action_dispatch/middleware/cookies.rb
13 actionpack/lib/action_dispatch/middleware/cookies.rb
View
@@ -7,7 +7,7 @@ def cookie_jar
end
end
- # Cookies are read and written through ActionController#cookies.
+ # \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
@@ -21,6 +21,15 @@ def cookie_jar
# # Sets a cookie that expires in 1 hour.
# cookies[:login] = { :value => "XJ-122", :expires => 1.hour.from_now }
#
+ # # Sets a signed cookie, which prevents a user from tampering with its value.
+ # # You must specify a value in ActionController::Base.cookie_verifier_secret.
+ # cookies.signed[:remember_me] = [current_user.id, current_user.salt]
+ #
+ # # Sets a "permanent" cookie (which expires in 20 years from now).
+ # cookies.permanent[:login] = "XJ-122"
+ # # You can also chain these methods:
+ # cookies.permanent.signed[:login] = "XJ-122"
+ #
# Examples for reading:
#
# cookies[:user_name] # => "david"
@@ -55,7 +64,7 @@ def cookie_jar
# :domain => :all # Allow the cookie for the top most level
# domain and subdomains.
#
- # * <tt>:expires</tt> - The time at which this cookie expires, as a Time object.
+ # * <tt>:expires</tt> - The time at which this cookie expires, as a \Time object.
# * <tt>:secure</tt> - Whether this cookie is a only transmitted to HTTPS servers.
# Default is +false+.
# * <tt>:httponly</tt> - Whether this cookie is accessible via scripting or
Please sign in to comment.
Something went wrong with that request. Please try again.