Module: ActiveSupport::Callbacks::ClassMethods

### Home Classes Methods

### In Files

- lib/active_support/callbacks.rb

### Methods

- #__callback_runner_name
- #__reset_runner
- #define_callbacks
- #reset_callbacks
- #set_callback
- #skip_callback

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# ActiveSupport::Callbacks::ClassMethods

### Public Instance Methods

__callback_runner_name(key, kind) click to toggle source

    # File lib/active_support/callbacks.rb, line 413
    def __callback_runner_name(key, kind)
      "_run__#{self.name.hash.abs}__#{kind}__#{key.hash.abs}__callbacks"
    end

__reset_runner(symbol) click to toggle source

    # File lib/active_support/callbacks.rb, line 408
    def __reset_runner(symbol)
      name = __callback_runner_name(nil, symbol)
      undef_method(name) if method_defined?(name)
    end

define_callbacks(*callbacks) click to toggle source

Define sets of events in the object lifecycle that support callbacks.

    define_callbacks :validate
    define_callbacks :initialize, :save, :destroy

##### Options

- `:terminator` - Determines when a before filter will halt the callback chain, preventing following callbacks from being called and the event from being triggered. This is a string to be eval'ed. The result of the callback is available in the `result` variable.

      define_callbacks :validate, :terminator => "result == false"

  In this example, 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. By setting this option to `true` exception raised by given block is stored and after executing all the after callbacks the stored exception is raised.

- `:scope` - Indicates which methods should be executed when an object is used as a callback.

      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`.

    # File lib/active_support/callbacks.rb, line 616
    def define_callbacks(*callbacks)
      config = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
      callbacks.each do |callback|
        class_attribute "_#{callback}_callbacks"
        send("_#{callback}_callbacks=", CallbackChain.new(callback, config))
        __define_runner(callback)
      end
    end

reset_callbacks(symbol) click to toggle source

Remove all set callbacks for the given event.

    # File lib/active_support/callbacks.rb, line 535
    def reset_callbacks(symbol)
      callbacks = send("_#{symbol}_callbacks")

      ActiveSupport::DescendantsTracker.descendants(self).each do |target|
        chain = target.send("_#{symbol}_callbacks").dup
        callbacks.each { |c| chain.delete(c) }
        target.send("_#{symbol}_callbacks=", chain)
        target.__reset_runner(symbol)
      end

      self.send("_#{symbol}_callbacks=", callbacks.dup.clear)

      __reset_runner(symbol)
    end

set_callback(name, *filter_list, &block) click to toggle source

Install a callback for the given event.

    set_callback :save, :before, :before_meth
    set_callback :save, :after,  :after_meth, :if => :condition
    set_callback :save, :around, lambda { |r| stuff; result = yield; stuff }

The second arguments 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_meth

The callback can specified as a symbol naming an instance method; as a proc, lambda, or block; as a string to be instance evaluated; or as an object that responds to a certain method determined by the `:scope` argument to `define_callback`.

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 naming an instance method or a proc; the callback will be called only when it returns a true value.

- `:unless` - A symbol naming an instance method or a proc; the callback will be called only when it returns a false value.

- `:prepend` - If true, the callback will be prepended to the existing chain rather than appended.

- `:per_key` - A hash with `:if` and `:unless` options; see "Per-key conditions" below.

##### Per-key conditions

When creating or skipping callbacks, you can specify conditions that are always the same for a given key. For instance, in Action Pack, we convert :only and :except conditions into per-key conditions.

    before_filter :authenticate, :except => "index"

becomes

    set_callback :process_action, :before, :authenticate, :per_key => {:unless => proc {|c| c.action_name == "index"}}

Per-key conditions are evaluated only once per use of a given key. In the case of the above example, you would do:

    run_callbacks(:process_action, action_name) { ... dispatch stuff ... }

In that case, each action_name would get its own compiled callback method that took into consideration the per_key conditions. This is a speed improvement for ActionPack.

    # File lib/active_support/callbacks.rb, line 491
    def set_callback(name, *filter_list, &block)
      mapped = nil

      __update_callbacks(name, filter_list, block) do |target, chain, type, filters, options|
        mapped ||= filters.map do |filter|
          Callback.new(chain, filter, type, options.dup, self)
        end

        filters.each do |filter|
          chain.delete_if {|c| c.matches?(type, filter) }
        end

        options[:prepend] ? chain.unshift(*(mapped.reverse)) : chain.push(*mapped)

        target.send("_#{name}_callbacks=", chain)
      end
    end

skip_callback(name, *filter_list, &block) click to toggle source

Skip a previously set callback. Like `set_callback`, `:if` or `:unless` options may be passed in order to control when the callback is skipped.

    class Writer < Person
       skip_callback :validate, :before, :check_membership, :if => lambda { self.age > 18 }
    end

    # File lib/active_support/callbacks.rb, line 516
    def skip_callback(name, *filter_list, &block)
      __update_callbacks(name, filter_list, block) do |target, chain, type, filters, options|
        filters.each do |filter|
          filter = chain.find {|c| c.matches?(type, filter) }

          if filter && options.any?
            new_filter = filter.clone(chain, self)
            chain.insert(chain.index(filter), new_filter)
            new_filter.recompile!(options, options[:per_key] || {})
          end

          chain.delete(filter)
        end
        target.send("_#{name}_callbacks=", chain)
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.