class Time

Same name in this branch
  1. 10 core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time
Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time
  2. 9 core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time
  3. 8.9.x core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time
  4. 8.9.x core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time
  5. 11.x core/modules/views/src/Plugin/views/cache/Time.php \Drupal\views\Plugin\views\cache\Time
  6. 11.x core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time

Simple caching of query results for Views displays.

Hierarchy

Expanded class hierarchy of Time

Related topics

24 string references to 'Time'
CacheTest::testCacheData in core/modules/views/tests/src/Kernel/Plugin/CacheTest.php
Tests the data contained in cached items.
CacheTest::testHeaderStorage in core/modules/views/tests/src/Kernel/Plugin/CacheTest.php
Tests css/js storage and restoring mechanism.
CacheTest::testTimeResultCaching in core/modules/views/tests/src/Kernel/Plugin/CacheTest.php
Tests time based caching.
CacheTest::testTimeResultCachingWithFilter in core/modules/views/tests/src/Kernel/Plugin/CacheTest.php
Tests result caching with filters.
CacheTest::testTimeResultCachingWithPager in core/modules/views/tests/src/Kernel/Plugin/CacheTest.php
Tests result caching with a pager.

... See full list

File

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

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.
     * @param \Drupal\Component\Datetime\TimeInterface|null $time
     *   The time service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatterInterface $date_formatter, ?TimeInterface $time = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->dateFormatter = $date_formatter;
        if (!$time) {
            @trigger_error('Calling ' . __METHOD__ . ' without the $time argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3395991', E_USER_DEPRECATED);
            $this->time = \Drupal::service('datetime.time');
        }
    }
    
    /**
     * {@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'), $container->get('datetime.time'));
    }
    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 = $this->time
                ->getRequestTime() - $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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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.
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
PluginBase::$definition public property Plugins' 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::$position public property The handler position.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
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 Initialize the plugin. Overrides ViewsPluginInterface::init 6
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query 8
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 Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm 16
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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 Returns 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 Deprecated constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.