class SmartTag in Tome 8
Omits list cache tags from a View and expires cache on entity CRUD.
Plugin annotation
@ViewsCache(
id = "tome_static_super_cache_smart_tag",
title = @Translation("Smart tag based"),
help = @Translation("Tag based caching of data, where entity CRUD is used for expiry instead of list cache tags.")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\cache\CachePluginBase
- class \Drupal\tome_static_super_cache\Plugin\views\cache\SmartTag
- class \Drupal\views\Plugin\views\cache\CachePluginBase
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SmartTag
1 file declares its use of SmartTag
- tome_static_super_cache.module in modules/
tome_static/ modules/ tome_static_super_cache/ tome_static_super_cache.module - Contains functions for the Tome Static Super Cache module.
File
- modules/
tome_static/ modules/ tome_static_super_cache/ src/ Plugin/ views/ cache/ SmartTag.php, line 19
Namespace
Drupal\tome_static_super_cache\Plugin\views\cacheView source
class SmartTag extends CachePluginBase {
/**
* Determines whether or not cache should be used. Defaults to TRUE.
*
* @var bool
*/
protected $cache = FALSE;
/**
* {@inheritdoc}
*/
public function getCacheTags() {
$tags = $this->view->storage
->getCacheTags();
$tags = Cache::mergeTags($tags, $this->view
->getQuery()
->getCacheTags());
$tags = Cache::mergeTags($tags, [
$this
->getTagForView($this->view),
]);
return $tags;
}
/**
* {@inheritdoc}
*/
public function summaryTitle() {
return $this
->t('Smart tag based');
}
/**
* {@inheritdoc}
*/
protected function cacheExpire($type) {
return FALSE;
}
/**
* {@inheritdoc}
*/
protected function getDefaultCacheMaxAge() {
return CacheBackendInterface::CACHE_PERMANENT;
}
/**
* Determines the cache tag for the given View.
*
* @param \Drupal\views\ViewExecutable $view
* A View executable.
*
* @return string
* The cache tag for the given View.
*/
public function getTagForView(ViewExecutable $view) {
return implode(':', [
'tome_static_super_cache_smart_tag',
$view
->id(),
$view->current_display,
]);
}
/**
* Disables cache.
*/
public function disableCache() {
$this->cache = FALSE;
}
/**
* Enables cache.
*/
public function enableCache() {
$this->cache = TRUE;
}
/**
* {@inheritdoc}
*/
public function cacheGet($type) {
if ($this->cache) {
return parent::cacheGet($type);
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function cacheSet($type) {
if ($this->cache) {
parent::cacheSet($type);
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CachePluginBase:: |
protected | property | Which cache bin to store query results in. | |
CachePluginBase:: |
protected | property | Stores the cache ID used for the results cache. | |
CachePluginBase:: |
public | property | Contains all data that should be written/read from cache. | |
CachePluginBase:: |
public | function | Alters the cache metadata of a display upon saving a view. | |
CachePluginBase:: |
public | function | Clear out cached data for a view. | |
CachePluginBase:: |
protected | function | Determine expiration time in the cache table of the cache type or CACHE_PERMANENT if item shouldn't be removed automatically from cache. | 1 |
CachePluginBase:: |
public | function | Calculates and sets a cache ID used for the result cache. | |
CachePluginBase:: |
public | function | Gets the max age for the current view. | |
CachePluginBase:: |
public | function | Returns the resultsKey property. | |
CachePluginBase:: |
public | function | Returns the row cache keys. | |
CachePluginBase:: |
public | function | Returns the row cache tags. | |
CachePluginBase:: |
public | function | Returns a unique identifier for the specified row. | |
CachePluginBase:: |
public | function | Post process any rendered data. | |
CachePluginBase:: |
protected | function | Prepares the view result before putting it into cache. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function |
Provide a form to edit options for this plugin. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
14 |
PluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
62 |
PluginBase:: |
protected | function | Information about options for all kinds of purposes will be held here. | 18 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Handle any special handling on the validate form. Overrides ViewsPluginInterface:: |
16 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Validate the options form. Overrides ViewsPluginInterface:: |
15 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
PluginBase:: |
public | function |
Constructs a PluginBase object. Overrides PluginBase:: |
|
SmartTag:: |
protected | property | Determines whether or not cache should be used. Defaults to TRUE. | |
SmartTag:: |
protected | function |
Determine the expiration time of the cache type, or NULL if no expire. Overrides CachePluginBase:: |
|
SmartTag:: |
public | function |
Retrieve data from the cache. Overrides CachePluginBase:: |
|
SmartTag:: |
public | function |
Save data to the cache. Overrides CachePluginBase:: |
|
SmartTag:: |
public | function | Disables cache. | |
SmartTag:: |
public | function | Enables cache. | |
SmartTag:: |
public | function |
Gets an array of cache tags for the current view. Overrides CachePluginBase:: |
|
SmartTag:: |
protected | function |
Returns the default cache max age. Overrides CachePluginBase:: |
|
SmartTag:: |
public | function | Determines the cache tag for the given View. | |
SmartTag:: |
public | function |
Return a string to display as the clickable title for the
access control. Overrides CachePluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |