module AbstractController::Callbacks::ClassMethods

Public Instance Methods

_insert_callbacks(callbacks, block = nil) { |callback, options| ... } Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 71
def _insert_callbacks(callbacks, block = nil)
  options = callbacks.extract_options!
  _normalize_callback_options(options)
  callbacks.push(block) if block
  callbacks.each do |callback|
    yield callback, options
  end
end

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

_normalize_callback_options(options) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 33
def _normalize_callback_options(options)
  _normalize_callback_option(options, :only, :if)
  _normalize_callback_option(options, :except, :unless)
end

If :only or :except are used, convert the options into the :unless and :if options of ActiveSupport::Callbacks. The basic idea is that :only => :index gets converted to :if => proc {|c| c.action_name == “index” }.

Options

  • only - The callback should be run only for this action

  • except - The callback should be run for all actions except this action

after_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 115
      

Append a callback after actions. See #_insert_callbacks for parameter details.

append_after_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 136
      

Append a callback after actions. See #_insert_callbacks for parameter details.

append_around_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 164
      

Append a callback around actions. See #_insert_callbacks for parameter details.

append_before_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 108
      

Append a callback before actions. See #_insert_callbacks for parameter details.

around_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 143
      

Append a callback around actions. See #_insert_callbacks for parameter details.

before_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 87
      

Append a callback before actions. See #_insert_callbacks for parameter details.

prepend_after_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 122
      

Prepend a callback after actions. See #_insert_callbacks for parameter details.

prepend_around_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 150
      

Prepend a callback around actions. See #_insert_callbacks for parameter details.

prepend_before_action(names, block) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 94
      

Prepend a callback before actions. See #_insert_callbacks for parameter details.

skip_action_callback(*names) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 52
def skip_action_callback(*names)
  skip_before_action(*names)
  skip_after_action(*names)
  skip_around_action(*names)
end

Skip before, after, and around action callbacks matching any of the names.

Parameters

  • names - A list of valid names that could be used for callbacks. Note that skipping uses Ruby equality, so it's impossible to skip a callback defined using an anonymous proc using skip_action_callback

Also aliased as: skip_filter
skip_after_action(names) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 129
      

Skip a callback after actions. See #_insert_callbacks for parameter details.

skip_around_action(names) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 157
      

Skip a callback around actions. See #_insert_callbacks for parameter details.

skip_before_action(names) Show source
# File actionpack/lib/abstract_controller/callbacks.rb, line 101
      

Skip a callback before actions. See #_insert_callbacks for parameter details.

skip_filter(*names)

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.