Module: ActionView::Helpers::CacheHelper

Included in:
ActionView::Helpers
Defined in:
lib/action_view/helpers/cache_helper.rb

Instance Method Summary collapse

Instance Method Details

#cache(name = {}, options = nil, &block) ⇒ Object

This helper to exposes a method for caching of view fragments. See ActionController::Caching::Fragments for usage instructions.

A method for caching fragments of a view rather than an entire action or page. This technique is useful caching pieces like menus, lists of news topics, static HTML fragments, and so on. This method takes a block that contains the content you wish to cache. See ActionController::Caching::Fragments for more information.

Examples

If you wanted to cache a navigation menu, you could do the following.

<% cache do %>
  <%= render :partial => "menu" %>
<% end %>

You can also cache static content…

<% cache do %>
   <p>Hello users!  Welcome to our website!</p>
<% end %>

…and static content mixed with RHTML content.

<% cache do %>
  Topics:
  <%= render :partial => "topics", :collection => @topic_list %>
  <i>Topics listed alphabetically</i>
<% end %>



36
37
38
39
40
41
42
43
44
 
# File 'lib/action_view/helpers/cache_helper.rb', line 36

def cache(name = {}, options = nil, &block)
  if controller.perform_caching
    safe_concat(fragment_for(name, options, &block))
  else
    yield
  end

  nil
end