ContextAwarePluginBase
abstract class ContextAwarePluginBase extends ContextAwarePluginBase implements ContextAwarePluginInterface, CacheableDependencyInterface (View source)
Base class for plugins that are context aware.
Traits
Provides a trait to add context-aware functionality to plugins.
Wrapper methods for classes that needs typed data manager object.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginTrait |
| protected bool internal | $initializedContextConfig | Tracks whether the context has been initialized from configuration. |
from ContextAwarePluginTrait |
| protected TypedDataManagerInterface | $typedDataManager | The typed data manager used for creating the data types. |
from TypedDataTrait |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
Methods
Overrides \Drupal\Component\Plugin\PluginBase::__construct().
Creates context objects from any context mappings in configuration.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Overrides \Drupal\Component\Plugin\PluginBase::__construct().
Overrides the construction of context aware plugins to allow for unvalidated constructor based injection of contexts.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
abstract protected
getPluginDefinition()
{@inheritdoc}
bool
isConfigurable()
Determines if the plugin is configurable.
protected ContextInterface[]
createContextFromConfiguration(array $context_configuration)
Creates context objects from any context mappings in configuration.
ContextDefinitionInterface[]
getContextDefinitions()
{@inheritdoc}
ContextDefinitionInterface
getContextDefinition($name)
{@inheritdoc}
getContexts()
{@inheritdoc}
ContextInterface
getContext($name)
{@inheritdoc}
setContext($name, ContextInterface $context)
{@inheritdoc}
getContextValues()
{@inheritdoc}
getContextValue($name)
{@inheritdoc}
setContextValue($name, $value)
{@inheritdoc}
validateContexts()
{@inheritdoc}
getContextMapping()
{@inheritdoc}
setContextMapping(array $context_mapping)
{@inheritdoc}
getCacheContexts()
{@inheritdoc}
getCacheTags()
{@inheritdoc}
getCacheMaxAge()
{@inheritdoc}
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)
Sets the typed data manager.
TypedDataManagerInterface
getTypedDataManager()
Gets the typed data manager.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}