Provides a base class for DisplayVariant plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Display\VariantBase implements VariantInterface uses RefinableCacheableDependencyTrait, PluginDependencyTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
See also
\Drupal\Core\Display\Annotation\DisplayVariant
\Drupal\Core\Display\VariantInterface
\Drupal\Core\Display\VariantManager
Plugin API
File
- core/lib/Drupal/Core/Display/VariantBase.php, line 19
Namespace
Drupal\Core\Display
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. |
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. |
| DependencyTrait::addDependency | protected | function | Adds a dependency. |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. |
| PluginBase::$pluginId | protected | property | The plugin_id. |
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |
| 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 |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. |
| RefinableCacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. |
| RefinableCacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. |
| RefinableCacheableDependencyTrait::$cacheTags | protected | property | Cache tags. |
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency |
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts |
| RefinableCacheableDependencyTrait::addCacheTags | public | function | Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags |
| RefinableCacheableDependencyTrait::getCacheContexts | public | function | The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts |
| RefinableCacheableDependencyTrait::getCacheMaxAge | public | function | The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge |
| RefinableCacheableDependencyTrait::getCacheTags | public | function | The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags |
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
| 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. |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
| VariantBase::access | public | function | Determines if this display variant is accessible. Overrides VariantInterface::access |
| VariantBase::adminLabel | public | function | Returns the admin-facing display variant label. Overrides VariantInterface::adminLabel |
| VariantBase::buildConfigurationForm | public | function | Form constructor. Overrides PluginFormInterface::buildConfigurationForm |
| VariantBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies |
| VariantBase::defaultConfiguration | public | function | Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration |
| VariantBase::getConfiguration | public | function | Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration |
| VariantBase::getWeight | public | function | Returns the weight of the display variant. Overrides VariantInterface::getWeight |
| VariantBase::id | public | function | Returns the unique ID for the display variant. Overrides VariantInterface::id |
| VariantBase::label | public | function | Returns the user-facing display variant label. Overrides VariantInterface::label |
| VariantBase::setConfiguration | public | function | Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration |
| VariantBase::setWeight | public | function | Sets the weight of the display variant. Overrides VariantInterface::setWeight |
| VariantBase::submitConfigurationForm | public | function | Form submission handler. Overrides PluginFormInterface::submitConfigurationForm |
| VariantBase::validateConfigurationForm | public | function | Form validation handler. Overrides PluginFormInterface::validateConfigurationForm |
| VariantBase::__construct | public | function | Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct |
| VariantInterface::build | public | function | Builds and returns the renderable array for the display variant. |
Please login to continue.