Module | ActionController::Caching::Fragments |
In: |
lib/action_controller/caching/fragments.rb
|
Fragment caching is used for caching various blocks within views without caching the entire action as a whole. This is useful when certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple parties. The caching is done using the cache helper available in the Action View. A template with fragment caching might look like:
<b>Hello <%= @name %></b> <% cache do %> All the topics in the system: <%= render :partial => "topic", :collection => Topic.find(:all) %> <% end %>
This cache will bind the name of the action that called it, so if this code was part of the view for the topics/list action, you would be able to invalidate it using:
expire_fragment(:controller => "topics", :action => "list")
This default behavior is limited if you need to cache multiple fragments per action or if the action itself is cached using caches_action. To remedy this, there is an option to qualify the name of the cached fragment by using the :action_suffix option:
<% cache(:action => "list", :action_suffix => "all_topics") do %>
That would result in a name such as /topics/list/all_topics, avoiding conflicts with the action cache and with any fragments that use a different suffix. Note that the URL doesn‘t have to really exist or be callable
that we can refer to when we need to expire the cache.
The expiration call for this example is:
expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
Removes fragments from the cache.
key can take one of three forms:
options is passed through to the cache store‘s delete method (or delete_matched, for Regexp keys.)
Given a key (as described in expire_fragment), returns a key suitable for use in reading, writing, or expiring a cached fragment. If the key is a hash, the generated key is the return value of url_for on that hash (without the protocol). All keys are prefixed with views/ and uses ActiveSupport::Cache.expand_cache_key for the expansion.
Check if a cached fragment from the location signified by key exists (see expire_fragment for acceptable formats)
Reads a cached fragment from the location signified by key (see expire_fragment for acceptable formats).
Writes content to the location signified by key (see expire_fragment for acceptable formats).