Class/Module Index [+]

Quicksearch

ActionController::Caching

Caching is a cheap way of speeding up slow applications by keeping the result of calculations, renderings, and database calls around for subsequent requests. Action Controller affords you three approaches in varying levels of granularity: Page, Action, Fragment.

You can read more about each approach and the sweeping assistance by clicking the modules below.

Note: To turn off all caching and sweeping, set Base.perform_caching = false.

Caching stores

All the caching stores from ActiveSupport::Cache is available to be used as backends for Action Controller caching. This setting only affects action and fragment caching as page caching is always written to disk.

Configuration examples (MemoryStore is the default):

ActionController::Base.cache_store = :memory_store
ActionController::Base.cache_store = :file_store, "/path/to/cache/directory"
ActionController::Base.cache_store = :drb_store, "druby://localhost:9192"
ActionController::Base.cache_store = :mem_cache_store, "localhost"
ActionController::Base.cache_store = :mem_cache_store, Memcached::Rails.new("localhost:11211")
ActionController::Base.cache_store = MyOwnStore.new("parameter")

Public Class Methods

cache_configured?() click to toggle source
# File lib/action_controller/caching.rb, line 50
def self.cache_configured?
  perform_caching && cache_store
end
cache_store=(store_option) click to toggle source

Defines the storage option for cached fragments

# File lib/action_controller/caching.rb, line 40
def self.cache_store=(store_option)
  @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
end

Protected Instance Methods

cache(key, options = {}, &block) click to toggle source

Convenience accessor

# File lib/action_controller/caching.rb, line 58
def cache(key, options = {}, &block)
  if cache_configured?
    cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
  else
    yield
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.