define_callbacks
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0 (0)
- 2.2.1 (0)
- 2.3.8 (0)
- 3.0.0 (29)
- 3.0.9 (-2)
- 3.1.0 (7)
- 3.2.1 (0)
- 3.2.8 (0)
- 3.2.13 (0)
- 4.0.2 (0)
- 4.1.8 (1)
- 4.2.1 (1)
- 4.2.7 (0)
- 4.2.9 (0)
- 5.0.0.1 (2)
- 5.1.7
- 5.2.3
- 6.0.0
- 6.1.3.1
- 6.1.7.7
- 7.0.0
- 7.1.3.2
- 7.1.3.4
- What's this?
define_callbacks(*callbacks)
public
Defines callbacks types:
define_callbacks :validate
This macro accepts the following options:
- :terminator - Indicates when a before filter is considered
to be halted.
define_callbacks :validate, :terminator => "result == false"
In the example above, if any before validate callbacks returns false, other callbacks are not executed. Defaults to "false", meaning no value halts the chain.
- :rescuable - By default, after filters are not executed if
the given block or a before filter raises an error. Set this option to true to change this behavior.
- :scope - Indicates which methods should be executed when a class
is given as callback. Defaults to [:kind].
class Audit def before(caller) puts 'Audit: before is called' end def before_save(caller) puts 'Audit: before_save is called' end end class Account include ActiveSupport::Callbacks define_callbacks :save set_callback :save, :before, Audit.new def save run_callbacks :save do puts 'save in main' end end end
In the above case whenever you save an account the method Audit#before will be called. On the other hand
define_callbacks :save, :scope => [:kind, :name]
would trigger Audit#before_save instead. That’s constructed by calling "#{kind}_#{name}" on the given instance. In this case "kind" is "before" and "name" is "save". In this context ":kind" and ":name" have special meanings: ":kind" refers to the kind of callback (before/after/around) and ":name" refers to the method on which callbacks are being defined.
A declaration like
define_callbacks :save, :scope => [:name]
would call Audit#save.