module AbstractController::Callbacks::ClassMethods
Public instance methods
_insert_callbacks(callbacks, block = nil)
Take callback names and an optional callback proc, normalize them, then call the block with each callback. This allows us to abstract the normalization across several methods that use it.
Parameters
-
callbacks- An array of callbacks, with an optional options hash as the last parameter. -
block- A proc that should be added to the callbacks.
Block Parameters
-
name- The callback to be added. -
options- A hash of options to be used when adding the callback.
Source code GitHub
# File actionpack/lib/abstract_controller/callbacks.rb, line 119
def _insert_callbacks(callbacks, block = nil)
options = callbacks.extract_options!
callbacks.push(block) if block
options[:filters] = callbacks
_normalize_callback_options(options)
options.delete(:filters)
callbacks.each do |callback|
yield callback, options
end
end_normalize_callback_options(options)
If :only or :except are used, convert the options into the :if and :unless options of ActiveSupport::Callbacks.
The basic idea is that :only => :index gets converted to :if => proc {|c| c.action_name == "index" }.
Note that :only has priority over :if in case they are used together.
only: :index, if: -> { true } # the :if option will be ignored.
Note that :if has priority over :except in case they are used together.
except: :index, if: -> { true } # the :except option will be ignored.
Options
-
only- The callback should be run only for this action. -
except- The callback should be run for all actions except this action.
Source code GitHub
# File actionpack/lib/abstract_controller/callbacks.rb, line 94
def _normalize_callback_options(options)
_normalize_callback_option(options, :only, :if)
_normalize_callback_option(options, :except, :unless)
endafter_action(names, block)
Append a callback after actions. See _insert_callbacks for parameter details.
append_after_action(names, block)
Append a callback after actions. See _insert_callbacks for parameter details.
append_around_action(names, block)
Append a callback around actions. See _insert_callbacks for parameter details.
append_before_action(names, block)
Append a callback before actions. See _insert_callbacks for parameter details.
If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.
around_action(names, block)
Append a callback around actions. See _insert_callbacks for parameter details.
before_action(names, block)
Append a callback before actions. See _insert_callbacks for parameter details.
If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.
prepend_after_action(names, block)
Prepend a callback after actions. See _insert_callbacks for parameter details.
prepend_around_action(names, block)
Prepend a callback around actions. See _insert_callbacks for parameter details.
prepend_before_action(names, block)
Prepend a callback before actions. See _insert_callbacks for parameter details.
If the callback renders or redirects, the action will not run. If there are additional callbacks scheduled to run after that callback, they are also cancelled.
skip_after_action(names)
Skip a callback after actions. See _insert_callbacks for parameter details.
skip_around_action(names)
Skip a callback around actions. See _insert_callbacks for parameter details.
skip_before_action(names)
Skip a callback before actions. See _insert_callbacks for parameter details.