You are here

class views_plugin_cache_rules in Cache Actions 7

Same name and namespace in other branches
  1. 6.2 views_plugin_cache_rules.inc \views_plugin_cache_rules
  2. 6 views_plugin_cache_rules.inc \views_plugin_cache_rules

Plugin that caches views infinitely. This is not really that useful unless you want rules to invalidate your cache.

Hierarchy

Expanded class hierarchy of views_plugin_cache_rules

1 string reference to 'views_plugin_cache_rules'
cache_actions_views_plugins in ./cache_actions.views.inc
Implementation of hook_views_plugins().

File

./views_plugin_cache_rules.inc, line 12
This file contains a cache that just implements the views cache plugin.

View source
class views_plugin_cache_rules extends views_plugin_cache {
  function summary_title() {
    return t('Rules');
  }

  /**
   * Since rules will be triggering our cache invalidation,
   * the cache will never expire.
   * @param $type
   * @return always FALSE.
   */
  function cache_expire($type) {
    return FALSE;
  }

  /**
   * We override the default caching mechanism, since it nukes everything.
   * We are just going to flush the actual display.
   */
  function cache_flush() {
    cache_clear_all($this->view->name . ':' . $this->display->id, $this->table, TRUE);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::option_definition public function Information about options for all kinds of purposes will be held here. 13
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_form public function Provide a form to edit options for this plugin. 13
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::options_validate public function Validate the options form. 10
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::query public function Add anything to the query that we might need to. 7
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_cache::$storage public property Contains all data that should be written/read from cache.
views_plugin_cache::$table public property What table to store data in.
views_plugin_cache::assetDiff protected function Computes the differences between two JS/CSS asset arrays.
views_plugin_cache::cache_get public function Retrieve data from the cache. 2
views_plugin_cache::cache_set public function Save data to the cache. 2
views_plugin_cache::cache_set_expire public function Determine expiration time in the cache table of the cache type. 1
views_plugin_cache::cache_start public function Start caching JavaScript, css and other out of band info. 1
views_plugin_cache::gather_headers public function Gather out of band data, compare it to the start data and store the diff.
views_plugin_cache::get_cache_key public function Returns cache key.
views_plugin_cache::get_output_key public function
views_plugin_cache::get_results_key public function
views_plugin_cache::init public function Initialize the plugin.
views_plugin_cache::post_render public function Post process any rendered data.
views_plugin_cache::restore_headers public function Restore out of band data saved to cache. Copied from Panels.
views_plugin_cache_rules::cache_expire function Since rules will be triggering our cache invalidation, the cache will never expire. Overrides views_plugin_cache::cache_expire
views_plugin_cache_rules::cache_flush function We override the default caching mechanism, since it nukes everything. We are just going to flush the actual display. Overrides views_plugin_cache::cache_flush
views_plugin_cache_rules::summary_title function Return a string to display as the clickable title for the access control. Overrides views_plugin_cache::summary_title