123456789_123456789_123456789_123456789_123456789_

Module: AbstractController::Callbacks::ClassMethods

Relationships & Source Files
Defined in: actionpack/lib/abstract_controller/callbacks.rb

Instance Method Summary

Instance Method Details

#_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

[ GitHub ]

  
# 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

#_normalize_callback_options(options)

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

[ GitHub ]

  
# 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

#after_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 109

rdoc_method :method: after_action

#append_after_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 130

rdoc_method :method: append_after_action

#append_around_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 158

rdoc_method :method: append_around_action

#append_before_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 102

rdoc_method :method: append_before_action

#around_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 137

rdoc_method :method: around_action

#before_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 81

rdoc_method :method: before_action

#prepend_after_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 116

rdoc_method :method: prepend_after_action

#prepend_around_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 144

rdoc_method :method: prepend_around_action

#prepend_before_action(names, block)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 88

rdoc_method :method: prepend_before_action

#skip_action_callback(*names) Also known as: #skip_filter

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

[ GitHub ]

  
# 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_after_action(names)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 123

rdoc_method :method: skip_after_action

#skip_around_action(names)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 151

rdoc_method :method: skip_around_action

#skip_before_action(names)

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

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 95

rdoc_method :method: skip_before_action

#skip_filter(*names)

[ GitHub ]

  
# File 'actionpack/lib/abstract_controller/callbacks.rb', line 57

alias_method :skip_filter, :skip_action_callback