123456789_123456789_123456789_123456789_123456789_

Module: ActionController::Redirecting

Relationships & Source Files
Namespace Children
Exceptions:
UnsafeRedirectError
Extension / Inclusion / Inheritance Descendants
Included In:
API, Base, ::ActionView::TestCase::TestController, Rails::ApplicationController, Rails::InfoController, Rails::MailersController, Rails::WelcomeController
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::Concern
Instance Chain:
self, UrlFor, ::AbstractController::UrlFor, ::ActionDispatch::Routing::UrlFor, ::ActionDispatch::Routing::PolymorphicRoutes, ::ActiveSupport::Benchmarkable
Defined in: actionpack/lib/action_controller/metal/redirecting.rb

Constant Summary

::AbstractController::Logger - Attributes & Methods

Class Method Summary

::ActiveSupport::Concern - Extended

class_methods

Define class methods from given block.
included

Evaluate given block in context of base class, so that you can write class macros here.
prepended

Evaluate given block in context of base class, so that you can write class macros here.

Instance Attribute Summary

::AbstractController::UrlFor - Included

#default_url_options, #default_url_options?

Instance Method Summary

UrlFor - Included

#url_options

::AbstractController::UrlFor - Included

#_routes

::ActionDispatch::Routing::UrlFor - Included

#initialize,
#route_for

Allows calling direct or regular named route.
#url_for

Generate a URL based on the options provided, default_url_options and the routes defined in routes.rb.
#url_options

Hook overridden in controller to add request information with default_url_options.
#_routes_context, #_with_routes

::ActionDispatch::Routing::PolymorphicRoutes - Included

#polymorphic_path

Returns the path component of a URL for the given record.
#polymorphic_url

Constructs a call to a named RESTful route for the given record and returns the resulting URL string.

::ActiveSupport::Benchmarkable - self

#benchmark

Allows you to measure the execution time of a block in a template and records the result to the log.

Class Attribute Details

.logger (rw)

[ GitHub ] 

  


# File 'actionpack/lib/abstract_controller/logger.rb', line 10



config_accessor :logger


  







Instance Attribute Details



  

    #logger   (rw)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/abstract_controller/logger.rb', line 10



config_accessor :logger


  







Instance Method Details



  

    #redirect_back(fallback_location:, allow_other_host: true, **args)  
  



  

    

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 fallback_location will be used.



redirect_back fallback_location: { action: "show", id: 5 }
redirect_back fallback_location: @post
redirect_back fallback_location: "http://www.rubyonrails.org"
redirect_back fallback_location: "/images/screenshot.jpg"
redirect_back fallback_location: posts_url
redirect_back fallback_location: proc { edit_post_url(@post) }
redirect_back fallback_location: '/', allow_other_host: false



Options


  • 

    :fallback_location - The default fallback location that will be used on missing Referer header.
    

  • 

    :allow_other_host - Allow or disallow redirection to the host that is different to the current host, defaults to true.
    




All other options that can be passed to #redirect_to are accepted as options and the behavior is identical.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_controller/metal/redirecting.rb', line 98



def redirect_back(fallback_location:, allow_other_host: true, **args)
  referer = request.headers["Referer"]
  redirect_to_referer = referer && (allow_other_host || _url_host_allowed?(referer))
  redirect_to redirect_to_referer ? referer : fallback_location, **args
end


  








  

    #redirect_to(options = {}, response_options = {})  
  



  

    

Redirects the browser to the target specified in options. This parameter can be any one of:


  • 

    ::Hash - The URL will be generated by calling url_for with the options.
    

  • 

    Record - The URL will be generated by calling url_for with the options, which will reference a named URL for that record.
    

  • 

    ::String starting with protocol:// (like http://) or a protocol relative reference (like //) - Is passed straight through as the target for redirection.
    

  • 

    ::String not containing a protocol - The current protocol and host is prepended to the string.
    

  • 

    Proc - A block that will be executed in the controller’s context. Should return any option accepted by redirect_to.
    




Examples:



redirect_to action: "show", id: 5
redirect_to @post
redirect_to "http://www.rubyonrails.org"
redirect_to "/images/screenshot.jpg"
redirect_to posts_url
redirect_to proc { edit_post_url(@post) }



The redirection happens as a 302 Found header unless otherwise specified using the :status option:



redirect_to post_url(@post), status: :found
redirect_to action: 'atom', status: :moved_permanently
redirect_to post_url(@post), status: 301
redirect_to action: 'atom', status: 302



The status code can either be a standard HTTP Status code as an integer, or a symbol representing the downcased, underscored and symbolized description. Note that the status code must be a 3xx HTTP code, or redirection will not occur.



If you are using XHR requests other than GET or POST and redirecting after the request then some browsers will follow the redirect using the original request method. This may lead to undesirable behavior such as a double DELETE. To work around this you can return a 303 See Other status code which will be followed using a GET request.



redirect_to posts_url, status: :see_other
redirect_to action: 'index', status: 303



It is also possible to assign a flash message as part of the redirection. There are two special accessors for the commonly used flash names alert and notice as well as a general purpose flash bucket.



redirect_to post_url(@post), alert: "Watch it, mister!"
redirect_to post_url(@post), status: :found, notice: "Pay attention to the road"
redirect_to post_url(@post), status: 301, flash: { updated_post_id: @post.id }
redirect_to({ action: 'atom' }, alert: "Something serious happened")



Statements after redirect_to in our controller get executed, so redirect_to doesn’t stop the execution of the function. To terminate the execution of the function immediately after the redirect_to, use return.



redirect_to post_url(@post) and return


  





  
Raises:





  [ GitHub ]


  

  


# File 'actionpack/lib/action_controller/metal/redirecting.rb', line 62



def redirect_to(options = {}, response_options = {})
  raise ActionControllerError.new("Cannot redirect to nil!") unless options
  raise AbstractController::DoubleRenderError if response_body

  self.status        = _extract_redirect_to_status(options, response_options)

  redirect_to_location = _compute_redirect_to_location(request, options)
  _ensure_url_is_http_header_safe(redirect_to_location)

  self.location      = redirect_to_location
  self.response_body = "<html><body>You are being <a href=\"#{ERB::Util.unwrapped_html_escape(response.location)}\">redirected</a>.</body></html>"
end