class Tag in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/src/Plugin/views/cache/Tag.php \Drupal\views\Plugin\views\cache\Tag
Simple caching of query results for Views displays.
Plugin annotation
@ViewsCache(
id = "tag",
title = @Translation("Tag based"),
help = @Translation("Tag based caching of data. Caches will persist until any related cache tags are invalidated.")
)
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\views\Plugin\views\cache\Tag
- 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 Tag
Related topics
5 string references to 'Tag'
- filter_test.schema.yml in core/
modules/ filter/ tests/ filter_test/ config/ schema/ filter_test.schema.yml - core/modules/filter/tests/filter_test/config/schema/filter_test.schema.yml
- migrate_drupal.schema.yml in core/
modules/ migrate_drupal/ config/ schema/ migrate_drupal.schema.yml - core/modules/migrate_drupal/config/schema/migrate_drupal.schema.yml
- Tag::summaryTitle in core/
modules/ views/ src/ Plugin/ views/ cache/ Tag.php - Return a string to display as the clickable title for the access control.
- views.query.schema.yml in core/
modules/ views/ config/ schema/ views.query.schema.yml - core/modules/views/config/schema/views.query.schema.yml
- views.schema.yml in core/
modules/ views/ config/ schema/ views.schema.yml - core/modules/views/config/schema/views.schema.yml
File
- core/
modules/ views/ src/ Plugin/ views/ cache/ Tag.php, line 18
Namespace
Drupal\views\Plugin\views\cacheView source
class Tag extends CachePluginBase {
/**
* {@inheritdoc}
*/
public function summaryTitle() {
return $this
->t('Tag');
}
/**
* {@inheritdoc}
*/
protected function cacheExpire($type) {
return FALSE;
}
/**
* {@inheritdoc}
*/
protected function getDefaultCacheMaxAge() {
return CacheBackendInterface::CACHE_PERMANENT;
}
}
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:: |
public | function | Retrieve data from the cache. | 1 |
CachePluginBase:: |
public | function | Save data to the cache. | 1 |
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 | Gets an array of cache tags 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 | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
63 |
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:: |
2 |
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:: |
6 |
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:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
Tag:: |
protected | function |
Determine the expiration time of the cache type, or NULL if no expire. Overrides CachePluginBase:: |
|
Tag:: |
protected | function |
Returns the default cache max age. Overrides CachePluginBase:: |
|
Tag:: |
public | function |
Return a string to display as the clickable title for the
access control. Overrides CachePluginBase:: |
|
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. |