Module: ActionController::Redirecting

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: 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, ModelNaming, RackDelegation, ::ActiveSupport::Benchmarkable
Defined in:	actionpack/lib/action_controller/metal/redirecting.rb

::AbstractController::Logger - Attributes & Methods

.logger rw
#logger rw

Class Method Summary

::ActiveSupport::Concern - Extended

append_features, class_methods, included

Instance Attribute Summary

::AbstractController::UrlFor - Included

#default_url_options, #default_url_options?

RackDelegation - Included

#content_type, #headers, #location, #response_body=, #response_code, #status

Instance Method Summary

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

Redirects the browser to the target specified in options.

UrlFor - Included

#url_options

::AbstractController::UrlFor - Included

#_routes

::ActionDispatch::Routing::UrlFor - Included

#initialize,
#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`.

::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.

ModelNaming - Included

#convert_to_model	Converts the given object to an ::ActiveModel compliant one.
#model_name_from_record_or_class

::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 8


config_accessor :logger

Instance Attribute Details

#logger (rw)

[ GitHub ]

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


config_accessor :logger

Instance Method Details

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

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.
:back - Back to the page that issued the request. Useful for forms that are triggered from multiple places. Short-hand for redirect_to(request.env["HTTP_REFERER"])

Examples:

redirect_to action: "show", id: 5
redirect_to post
redirect_to "http://www.rubyonrails.org"
redirect_to "/images/screenshot.jpg"
redirect_to articles_url
redirect_to :back
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")

When using redirect_to :back, if there is no referrer, RedirectBackError will be raised. You may specify some fallback behavior for this case by rescuing RedirectBackError.

Raises:

(ActionControllerError)

[ GitHub ]

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


def redirect_to(options = {}, response_status = {}) #:doc:
  raise ActionControllerError.new("Cannot redirect to nil!") unless options
  raise ActionControllerError.new("Cannot redirect to a parameter hash!") if options.is_a?(ActionController::Parameters)
  raise AbstractController::DoubleRenderError if response_body

  self.status        = _extract_redirect_to_status(options, response_status)
  self.location      = _compute_redirect_to_location(request, options)
  self.response_body = "<html><body>You are being <a href=\"#{ERB::Util.unwrapped_html_escape(location)}\">redirected</a>.</body></html>"
end