module ActionController::Caching::Pages::ClassMethods - actionpack-3.2.22 Documentation

# module ActionController::Caching::Pages::ClassMethods

### Public Instance Methods

cache_page(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION) click to toggle source

Manually cache the `content` in the key determined by `path`. Example:

    cache_page "I'm the cached content", "/lists/show"

    # File lib/action_controller/caching/pages.rb, line 77
    def cache_page(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
      return unless perform_caching
      path = page_cache_path(path, extension)

      instrument_page_cache :write_page, path do
        FileUtils.makedirs(File.dirname(path))
        File.open(path, "wb+") { |f| f.write(content) }
        if gzip
          Zlib::GzipWriter.open(path + '.gz', gzip) { |f| f.write(content) }
        end
      end
    end

caches_page(*actions) click to toggle source

Caches the `actions` using the page-caching approach that’ll store the cache in a path within the page_cache_directory that matches the triggering url.

You can also pass a :gzip option to override the class configuration one.

Usage:

    # cache the index action
    caches_page :index

    # cache the index action except for JSON requests
    caches_page :index, :if => Proc.new { |c| !c.request.format.json? }

    # don't gzip images
    caches_page :image, :gzip => false

    # File lib/action_controller/caching/pages.rb, line 106
    def caches_page(*actions)
      return unless perform_caching
      options = actions.extract_options!

      gzip_level = options.fetch(:gzip, page_cache_compression)
      gzip_level = case gzip_level
      when Symbol
        Zlib.const_get(gzip_level.to_s.upcase)
      when Fixnum
        gzip_level
      when false
        nil
      else
        Zlib::BEST_COMPRESSION
      end

      after_filter({:only => actions}.merge(options)) do |c|
        c.cache_page(nil, nil, gzip_level)
      end
    end

expire_page(path) click to toggle source

Expires the page that was cached with the `path` as a key. Example:

    expire_page "/lists/show"

    # File lib/action_controller/caching/pages.rb, line 65
    def expire_page(path)
      return unless perform_caching
      path = page_cache_path(path)

      instrument_page_cache :expire_page, path do
        File.delete(path) if File.exist?(path)
        File.delete(path + '.gz') if File.exist?(path + '.gz')
      end
    end