You are here

Home » API reference » Drupal 10 » Time.php

class Time in Drupal 10

Same name in this branch
  1. 10 core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time
  2. 10 core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time
Same name and namespace in other branches
  1. 8 core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time
  2. 9 core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time

Simple caching of query results for Views displays.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of Time

Related topics

Views cache plugins
Plugins to handle Views caches.
1 string reference to 'Time'
Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php
Expands a datetime element type into date and/or time elements.

File

core/modules/views/src/Plugin/views/cache/Time.php, line 21

Namespace

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

  /**
   * {@inheritdoc}
   */
  protected $usesOptions = TRUE;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructs a Time cache plugin object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('date.formatter'));
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['results_lifespan'] = [
      'default' => 3600,
    ];
    $options['results_lifespan_custom'] = [
      'default' => 0,
    ];
    $options['output_lifespan'] = [
      'default' => 3600,
    ];
    $options['output_lifespan_custom'] = [
      'default' => 0,
    ];
    return $options;
  }
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = [
      60,
      300,
      1800,
      3600,
      21600,
      518400,
    ];
    $options = array_map([
      $this->dateFormatter,
      'formatInterval',
    ], array_combine($options, $options));
    $options = [
      0 => $this
        ->t('Never cache'),
    ] + $options + [
      'custom' => $this
        ->t('Custom'),
    ];
    $form['results_lifespan'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Query results'),
      '#description' => $this
        ->t('The length of time raw query results should be cached.'),
      '#options' => $options,
      '#default_value' => $this->options['results_lifespan'],
    ];
    $form['results_lifespan_custom'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Seconds'),
      '#size' => '25',
      '#maxlength' => '30',
      '#description' => $this
        ->t('Length of time in seconds raw query results should be cached.'),
      '#default_value' => $this->options['results_lifespan_custom'],
      '#states' => [
        'visible' => [
          ':input[name="cache_options[results_lifespan]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $form['output_lifespan'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Rendered output'),
      '#description' => $this
        ->t('The length of time rendered HTML output should be cached.'),
      '#options' => $options,
      '#default_value' => $this->options['output_lifespan'],
    ];
    $form['output_lifespan_custom'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Seconds'),
      '#size' => '25',
      '#maxlength' => '30',
      '#description' => $this
        ->t('Length of time in seconds rendered HTML output should be cached.'),
      '#default_value' => $this->options['output_lifespan_custom'],
      '#states' => [
        'visible' => [
          ':input[name="cache_options[output_lifespan]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
  }
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    $custom_fields = [
      'output_lifespan',
      'results_lifespan',
    ];
    foreach ($custom_fields as $field) {
      $cache_options = $form_state
        ->getValue('cache_options');
      if ($cache_options[$field] == 'custom' && !is_numeric($cache_options[$field . '_custom'])) {
        $form_state
          ->setError($form[$field . '_custom'], $this
          ->t('Custom time values must be numeric.'));
      }
    }
  }
  public function summaryTitle() {
    $results_lifespan = $this
      ->getLifespan('results');
    $output_lifespan = $this
      ->getLifespan('output');
    return $this->dateFormatter
      ->formatInterval($results_lifespan, 1) . '/' . $this->dateFormatter
      ->formatInterval($output_lifespan, 1);
  }
  protected function getLifespan($type) {
    $lifespan = $this->options[$type . '_lifespan'] == 'custom' ? $this->options[$type . '_lifespan_custom'] : $this->options[$type . '_lifespan'];
    return $lifespan;
  }
  protected function cacheExpire($type) {
    $lifespan = $this
      ->getLifespan($type);
    if ($lifespan) {
      $cutoff = REQUEST_TIME - $lifespan;
      return $cutoff;
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function cacheSetMaxAge($type) {
    $lifespan = $this
      ->getLifespan($type);
    if ($lifespan) {
      return $lifespan;
    }
    else {
      return Cache::PERMANENT;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultCacheMaxAge() {

    // The max age, unless overridden by some other piece of the rendered code
    // is determined by the output time setting.
    return (int) $this
      ->cacheSetMaxAge('output');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CachePluginBase::$resultsBin protected property Which cache bin to store query results in.
CachePluginBase::$resultsKey protected property Stores the cache ID used for the results cache.
CachePluginBase::$storage public property Contains all data that should be written/read from cache.
CachePluginBase::alterCacheMetadata public function Alters the cache metadata of a display upon saving a view.
CachePluginBase::cacheFlush public function Clear out cached data for a view.
CachePluginBase::cacheGet public function Retrieve data from the cache. 1
CachePluginBase::cacheSet public function Save data to the cache. 1
CachePluginBase::generateResultsKey public function Calculates and sets a cache ID used for the result cache.
CachePluginBase::getCacheMaxAge public function Gets the max age for the current view.
CachePluginBase::getCacheTags public function Gets an array of cache tags for the current view.
CachePluginBase::getResultsKey public function Returns the resultsKey property.
CachePluginBase::getRowCacheKeys public function Returns the row cache keys.
CachePluginBase::getRowCacheTags public function Returns the row cache tags.
CachePluginBase::getRowId public function Returns a unique identifier for the specified row.
CachePluginBase::postRender public function Post process any rendered data.
CachePluginBase::prepareViewResult protected function Prepares the view result before putting it into cache.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function 4
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function 1
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function 2
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
PluginBase::query public function 4
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm public function 4
PluginBase::themeFunctions public function
PluginBase::trustedCallbacks public static function 1
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 6
PluginBase::validate public function 2
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
Time::$dateFormatter protected property The date formatter service.
Time::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
Time::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides PluginBase::buildOptionsForm
Time::cacheExpire protected function Determine the expiration time of the cache type, or NULL if no expire. Overrides CachePluginBase::cacheExpire
Time::cacheSetMaxAge protected function Determine cache expiration time. Overrides CachePluginBase::cacheSetMaxAge
Time::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Time::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions
Time::getDefaultCacheMaxAge protected function Returns the default cache max age. Overrides CachePluginBase::getDefaultCacheMaxAge
Time::getLifespan protected 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
Time::__construct public function Constructs a Time cache plugin object. Overrides PluginBase::__construct
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.