class views_php_plugin_cache in Views PHP 7

Caching plugin that provides cache control based on custom PHP code.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_cache
      • class \views_php_plugin_cache

1 string reference to 'views_php_plugin_cache'

views_php_views_plugins in ./views_php.views.inc

Implements hook_views_plugins().

File

plugins/views/views_php_plugin_cache.inc, line 8

class views_php_plugin_cache extends views_plugin_cache {

  /**
   * Implements views_plugin_cache#summary_title().
   */
  public function summary_title() {
    return t('PHP');
  }

  /**
   * Implements views_object#option_definition().
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['php_cache_results'] = array(
      'default' => '',
    );
    $options['php_cache_output'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Implements views_plugin#options_form().
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form += views_php_form_element($this, FALSE, array(
      'php_cache_results',
      t('Result cache code'),
      t('The code must return TRUE if the cache is still fresh, FALSE otherwise.'),
      FALSE,
    ), array(
      '$view',
      '$plugin',
      '$cache',
    ));
    $form += views_php_form_element($this, FALSE, array(
      'php_cache_output',
      t('Output cache code'),
      t('The code must return TRUE if the cache is still fresh, FALSE otherwise.'),
      FALSE,
    ), array(
      '$view',
      '$plugin',
      '$cache',
    ));
  }

  /**
   * Implements views_plugin#options_submit()
   */
  public function options_submit(&$form, &$form_state) {
    $form_state['values']['cache_options'] += $form_state['values']['options'];
  }

  /**
   * Implements views_plugin_cache#cache_get()
   */
  public function cache_get($type) {

    // $cutoff = $this->cache_expire($type);
    switch ($type) {
      case 'query':

        // Not supported currently, but this is certainly where we'd put it.
        return FALSE;
      case 'results':
        $cache = cache_get($this
          ->get_results_key(), $this->table);
        $fresh = !empty($cache);
        if ($fresh && !empty($this->options['php_cache_results'])) {
          $code = $this->options['php_cache_results'] . ';';
          $function = function ($view, $plugin, $cache) use ($code) {
            eval($code);
          };
          ob_start();
          $fresh = $function($this->view, $this, $cache);
          ob_end_clean();
        }

        // Values to set: $view->result, $view->total_rows, $view->execute_time,
        // $view->current_page.
        if ($fresh) {

          // @code
          // if (!$cutoff || $cache->created > $cutoff) {
          // @endcode
          $this->view->result = $cache->data['result'];
          $this->view->total_rows = $cache->data['total_rows'];
          $this->view->set_current_page = $cache->data['current_page'];
          $this->view->execute_time = 0;
          return TRUE;

          // }
        }
        return FALSE;
      case 'output':
        $cache = cache_get($this
          ->get_output_key(), $this->table);
        $fresh = !empty($cache);
        if ($fresh && !empty($this->options['php_cache_output'])) {
          $code = $this->options['php_cache_output'] . ';';
          $function = function ($view, $plugin, $cache) use ($code) {
            eval($code);
          };
          ob_start();
          $fresh = $function($this->view, $this, $cache);
          ob_end_clean();
        }
        if ($fresh) {

          // @code
          // if (!$cutoff || $cache->created > $cutoff) {
          // @endcode
          $this->storage = $cache->data;
          $this->view->display_handler->output = $cache->data['output'];
          $this
            ->restore_headers();
          return TRUE;

          // }
        }
        return FALSE;
    }
  }

}

Members

Name	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::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_php_plugin_cache::cache_get	public	function	Implements views_plugin_cache#cache_get() Overrides views_plugin_cache::cache_get
views_php_plugin_cache::options_form	public	function	Implements views_plugin#options_form(). Overrides views_plugin::options_form
views_php_plugin_cache::options_submit	public	function	Implements views_plugin#options_submit() Overrides views_plugin::options_submit
views_php_plugin_cache::option_definition	public	function	Implements views_object#option_definition(). Overrides views_object::option_definition
views_php_plugin_cache::summary_title	public	function	Implements views_plugin_cache#summary_title(). Overrides views_plugin_cache::summary_title
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_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_expire	public	function	Determine the expiration time of the cache type, or NULL if no expire.	1
views_plugin_cache::cache_flush	public	function	Clear out cached data for a view.
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.