aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller
diff options
context:
space:
mode:
authorDerek Prior <derekprior@gmail.com>2015-12-17 20:57:42 -0500
committerDerek Prior <derekprior@gmail.com>2015-12-17 20:57:42 -0500
commit91e3aa194293e3211177922123e20d800e878d76 (patch)
treecf1964667715d21c52cf7796bc1176521816ac0e /actionpack/lib/action_controller
parent7a6772c0e7acc10f4edad8ce3e6d401524ea1336 (diff)
downloadrails-91e3aa194293e3211177922123e20d800e878d76.tar.gz
rails-91e3aa194293e3211177922123e20d800e878d76.tar.bz2
rails-91e3aa194293e3211177922123e20d800e878d76.zip
Document when fallback_location is used [ci-skip]
If you're not familiar with how the `Referer` header works, you likely won't understand why you need to provide a fallback or under what circumstances it would be used. Hopefully this clarifies things a bit.
Diffstat (limited to 'actionpack/lib/action_controller')
-rw-r--r--actionpack/lib/action_controller/metal/redirecting.rb10
1 files changed, 8 insertions, 2 deletions
diff --git a/actionpack/lib/action_controller/metal/redirecting.rb b/actionpack/lib/action_controller/metal/redirecting.rb
index aeecb48f85..513f0bc7e1 100644
--- a/actionpack/lib/action_controller/metal/redirecting.rb
+++ b/actionpack/lib/action_controller/metal/redirecting.rb
@@ -68,8 +68,14 @@ module ActionController
self.response_body = "<html><body>You are being <a href=\"#{ERB::Util.unwrapped_html_escape(location)}\">redirected</a>.</body></html>"
end
- # Redirects the browser to the page that issued the request if possible,
- # otherwise redirects to provided default fallback location.
+ # Redirects the browser to the page that issued the request (the referrer)
+ # if possible, otherwise redirects to the provided default fallback
+ # location.
+ #
+ # The referrer information is pulled from the HTTP `Referer` (sic) header on
+ # the request. This is an optional header and its presence on the request is
+ # subject to browser security settings and user preferences. If the request
+ # is missing this header, the <tt>fallback_location</tt> will be used.
#
# redirect_back fallback_location: { action: "show", id: 5 }
# redirect_back fallback_location: post