From 67194d9c2df972f7483177b8a33356c344e56a88 Mon Sep 17 00:00:00 2001 From: Michael Koziarski Date: Mon, 15 Jan 2007 07:17:58 +0000 Subject: Improve the documentation for customising your rescue actions. Closes #7041 [rsanheim] git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@5941 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- actionpack/lib/action_controller/rescue.rb | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/actionpack/lib/action_controller/rescue.rb b/actionpack/lib/action_controller/rescue.rb index e0107c5050..ca85ef34d0 100644 --- a/actionpack/lib/action_controller/rescue.rb +++ b/actionpack/lib/action_controller/rescue.rb @@ -1,10 +1,13 @@ module ActionController #:nodoc: # Actions that fail to perform as expected throw exceptions. These exceptions can either be rescued for the public view # (with a nice user-friendly explanation) or for the developers view (with tons of debugging information). The developers view - # is already implemented by the Action Controller, but the public view should be tailored to your specific application. So too - # could the decision on whether something is a public or a developer request. + # is already implemented by the Action Controller, but the public view should be tailored to your specific application. + # + # The default behavior for public exceptions is to render a static html file with the name of the error code thrown. If no such + # file exists, an empty response is sent with the correct status code. # - # You can tailor the rescuing behavior and appearance by overwriting the following two stub methods. + # You can override what constitutes a local request by overriding the local_request? method in your own controller. + # Custom rescue behavior is achieved by overriding the rescue_action_in_public and rescue_action_locally methods. module Rescue LOCALHOST = '127.0.0.1'.freeze @@ -74,12 +77,17 @@ module ActionController #:nodoc: end - # Overwrite to implement public exception handling (for requests answering false to local_request?). + # Overwrite to implement public exception handling (for requests answering false to local_request?). By + # default will call render_optional_error_file. Override this method to provide more user friendly error messages.s def rescue_action_in_public(exception) #:doc: render_optional_error_file response_code_for_rescue(exception) end - - def render_optional_error_file(status_code) #:nodoc: + + # Attempts to render a static error page based on the status_code thrown, + # or just return headers if no such file exists. For example, if a 500 error is + # being handled Rails will first attempt to render the file at public/500.html. + # If the file doesn't exist, the body of the response will be left empty + def render_optional_error_file(status_code) status = interpret_status(status_code) path = "#{RAILS_ROOT}/public/#{status[0,3]}.html" if File.exists?(path) -- cgit v1.2.3