PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of views_plugin

(no description)

File Size:	286 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

views_plugin_cache:: (13 methods):
  init()
  option_defaults()
  summary_title()
  cache_expire()
  cache_set()
  cache_get()
  cache_flush()
  post_render()
  cache_start()
  gather_headers()
  restore_headers()
  get_results_key()
  get_output_key()

Class: views_plugin_cache - X-Ref

The base plugin to handle caching.

init(&$view, &$display) X-Ref

Initialize the plugin.

param: $view
param: $display

option_defaults(&$options) X-Ref

Retrieve the default options when this is a new access
control plugin

summary_title() X-Ref

Return a string to display as the clickable title for the
access control.

cache_expire($type) X-Ref

Determine the expiration time of the cache type, or NULL if no expire.

Plugins must override this to implement expiration.

param: $type

cache_set($type) X-Ref

Save data to the cache.

A plugin should override this to provide specialized caching behavior.

cache_get($type) X-Ref

Retrieve data from the cache.

A plugin should override this to provide specialized caching behavior.

cache_flush() X-Ref

Clear out cached data for a view.

We're just going to nuke anything related to the view, regardless of display,
to be sure that we catch everything. Maybe that's a bad idea.

post_render(&$output) X-Ref

Post process any rendered data.

This can be valuable to be able to cache a view and still have some level of
dynamic output. In an ideal world, the actual output will include HTML
comment based tokens, and then the post process can replace those tokens.

Example usage. If it is known that the view is a node view and that the
primary field will be a nid, you can do something like this:



And then in the post render, create an array with the text that should
go there:

strtr($output, array('', 'output for FIELD of nid 1');

All of the cached result data will be available in $view->result, as well,
so all ids used in the query should be discoverable.

cache_start() X-Ref

Start caching javascript, css and other out of band info.

This takes a snapshot of the current system state so that we don't
duplicate it. Later on, when gather_headers() is run, this information
will be removed so that we don't hold onto it.

gather_headers() X-Ref

Gather out of band data, compare it to what we started with and store the difference.

restore_headers() X-Ref

Restore out of band data saved to cache. Copied from Panels.

get_results_key() X-Ref

No description

get_output_key() X-Ref

No description

PHP Cross Reference of Drupal 6 (gatewave)

/sites/all/modules/views/plugins/ -> views_plugin_cache.inc (summary)

Defines 1 class