You are here

class Time in Views (for Drupal 7) 8.3

Simple caching of query results for Views displays.

Plugin annotation


@Plugin(
  id = "time",
  title = @Translation("Time-based"),
  help = @Translation("Simple time-based caching of data.")
)

Hierarchy

Expanded class hierarchy of Time

Related topics

File

lib/Drupal/views/Plugin/views/cache/Time.php, line 25
Definition of Drupal\views\Plugin\views\cache\Time.

Namespace

Drupal\views\Plugin\views\cache
View source
class Time extends CachePluginBase {

  /**
   * Overrides Drupal\views\Plugin\Plugin::$usesOptions.
   */
  protected $usesOptions = TRUE;
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['results_lifespan'] = array(
      'default' => 3600,
    );
    $options['results_lifespan_custom'] = array(
      'default' => 0,
    );
    $options['output_lifespan'] = array(
      'default' => 3600,
    );
    $options['output_lifespan_custom'] = array(
      'default' => 0,
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = array(
      60,
      300,
      1800,
      3600,
      21600,
      518400,
    );
    $options = drupal_map_assoc($options, 'format_interval');
    $options = array(
      -1 => t('Never cache'),
    ) + $options + array(
      'custom' => t('Custom'),
    );
    $form['results_lifespan'] = array(
      '#type' => 'select',
      '#title' => t('Query results'),
      '#description' => t('The length of time raw query results should be cached.'),
      '#options' => $options,
      '#default_value' => $this->options['results_lifespan'],
    );
    $form['results_lifespan_custom'] = array(
      '#type' => 'textfield',
      '#title' => t('Seconds'),
      '#size' => '25',
      '#maxlength' => '30',
      '#description' => t('Length of time in seconds raw query results should be cached.'),
      '#default_value' => $this->options['results_lifespan_custom'],
      '#states' => array(
        'visible' => array(
          ':input[name="cache_options[results_lifespan]"]' => array(
            'value' => 'custom',
          ),
        ),
      ),
    );
    $form['output_lifespan'] = array(
      '#type' => 'select',
      '#title' => t('Rendered output'),
      '#description' => t('The length of time rendered HTML output should be cached.'),
      '#options' => $options,
      '#default_value' => $this->options['output_lifespan'],
    );
    $form['output_lifespan_custom'] = array(
      '#type' => 'textfield',
      '#title' => t('Seconds'),
      '#size' => '25',
      '#maxlength' => '30',
      '#description' => t('Length of time in seconds rendered HTML output should be cached.'),
      '#default_value' => $this->options['output_lifespan_custom'],
      '#states' => array(
        'visible' => array(
          ':input[name="cache_options[output_lifespan]"]' => array(
            'value' => 'custom',
          ),
        ),
      ),
    );
  }
  public function validateOptionsForm(&$form, &$form_state) {
    $custom_fields = array(
      'output_lifespan',
      'results_lifespan',
    );
    foreach ($custom_fields as $field) {
      if ($form_state['values']['cache_options'][$field] == 'custom' && !is_numeric($form_state['values']['cache_options'][$field . '_custom'])) {
        form_error($form[$field . '_custom'], t('Custom time values must be numeric.'));
      }
    }
  }
  public function summaryTitle() {
    $results_lifespan = $this
      ->get_lifespan('results');
    $output_lifespan = $this
      ->get_lifespan('output');
    return format_interval($results_lifespan, 1) . '/' . format_interval($output_lifespan, 1);
  }
  function get_lifespan($type) {
    $lifespan = $this->options[$type . '_lifespan'] == 'custom' ? $this->options[$type . '_lifespan_custom'] : $this->options[$type . '_lifespan'];
    return $lifespan;
  }
  function cache_expire($type) {
    $lifespan = $this
      ->get_lifespan($type);
    if ($lifespan) {
      $cutoff = REQUEST_TIME - $lifespan;
      return $cutoff;
    }
    else {
      return FALSE;
    }
  }
  function cache_set_expire($type) {
    $lifespan = $this
      ->get_lifespan($type);
    if ($lifespan) {
      return time() + $lifespan;
    }
    else {
      return CacheBackendInterface::CACHE_PERMANENT;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CachePluginBase::$outputKey protected property Stores the cache ID used for the output cache, once generateOutputKey() got executed.
CachePluginBase::$resultsKey protected property Stores the cache ID used for the results cache.
CachePluginBase::$storage property Contains all data that should be written/read from cache.
CachePluginBase::$table property What table to store data in.
CachePluginBase::cache_flush function Clear out cached data for a view.
CachePluginBase::cache_get function Retrieve data from the cache. 1
CachePluginBase::cache_set function Save data to the cache. 1
CachePluginBase::cache_start function Start caching javascript, css and other out of band info. 1
CachePluginBase::gather_headers function Gather out of band data, compare it to what we started with and store the difference.
CachePluginBase::generateOutputKey public function Calculates and sets a cache ID used for the output cache.
CachePluginBase::generateResultsKey public function Calculates and sets a cache ID used for the result cache.
CachePluginBase::getOutputKey public function Returns the outputKey property.
CachePluginBase::getResultsKey public function Returns the resultsKey property.
CachePluginBase::init public function Initialize the plugin.
CachePluginBase::post_render function Post process any rendered data.
CachePluginBase::restore_headers function Restore out of band data saved to cache. Copied from Panels.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::query public function Add anything to the query that we might need to. 13
PluginBase::setOptionDefaults protected function
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. 10
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
Time::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
Time::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides PluginBase::buildOptionsForm
Time::cache_expire function Determine the expiration time of the cache type, or NULL if no expire. Overrides CachePluginBase::cache_expire
Time::cache_set_expire function Determine expiration time in the cache table of the cache type or CACHE_PERMANENT if item shouldn't be removed automatically from cache. Overrides CachePluginBase::cache_set_expire
Time::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PluginBase::defineOptions
Time::get_lifespan function
Time::summaryTitle public function Return a string to display as the clickable title for the access control. Overrides CachePluginBase::summaryTitle
Time::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm