set_callback
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0 (0)
- 3.0.9 (-1)
- 3.1.0 (32)
- 3.2.1 (0)
- 3.2.8 (0)
- 3.2.13 (0)
- 4.0.2 (-20)
- 4.1.8 (0)
- 4.2.1 (0)
- 4.2.7 (3)
- 4.2.9 (0)
- 5.0.0.1 (0)
- 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?
set_callback(name, *filter_list, &block)
public
Install a callback for the given event.
set_callback :save, :before, :before_method set_callback :save, :after, :after_method, if: :condition set_callback :save, :around, ->(r, block) { stuff; result = block.call; stuff }
The second argument indicates whether the callback is to be run :before, :after, or :around the event. If omitted, :before is assumed. This means the first example above can also be written as:
set_callback :save, :before_method
The callback can be specified as a symbol naming an instance method; as a proc, lambda, or block; as a string to be instance evaluated(deprecated); or as an object that responds to a certain method determined by the :scope argument to define_callbacks.
If a proc, lambda, or block is given, its body is evaluated in the context of the current object. It can also optionally accept the current object as an argument.
Before and around callbacks are called in the order that they are set; after callbacks are called in the reverse order.
Around callbacks can access the return value from the event, if it wasn’t halted, from the yield call.
Options
-
:if - A symbol, a string or an array of symbols and strings, each naming an instance method or a proc; the callback will be called only when they all return a true value.
-
:unless - A symbol, a string or an array of symbols and strings, each naming an instance method or a proc; the callback will be called only when they all return a false value.
-
:prepend - If true, the callback will be prepended to the existing chain rather than appended.