1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Executable
  7. \
  8. ExecutablePluginBase

ExecutablePluginBase

abstract class ExecutablePluginBase extends ContextAwarePluginBase implements ExecutableInterface (View source)

Provides the basic architecture for executable plugins.

Traits

TypedDataTrait

Wrapper methods for classes that needs typed data manager object.

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

DependencySerializationTrait

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  ContextAwarePluginBase
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

__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Overrides \Drupal\Component\Plugin\PluginBase::__construct().

from  ContextAwarePluginBase
string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginBase
string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  PluginBase
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  PluginBase
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
__get($name)

Implements magic __get() method.

from  ContextAwarePluginBase
ContextInterface[]
createContextFromConfiguration(array $context_configuration)

Creates context objects from any context mappings in configuration.

from  ContextAwarePluginBase
ContextDefinitionInterface[]
getContextDefinitions()

Gets the context definitions of the plugin.

from  ContextAwarePluginBase
ContextDefinitionInterface
getContextDefinition(string $name)

Gets a specific context definition of the plugin.

from  ContextAwarePluginBase
array
getContexts()

Gets the defined contexts.

from  ContextAwarePluginBase
ContextInterface
getContext(string $name)

Gets a defined context.

from  ContextAwarePluginBase
setContext(string $name, ContextInterface $context)

Set a context on this plugin.

from  ContextAwarePluginBase
array
getContextValues()

Gets the values for all defined contexts.

from  ContextAwarePluginBase
mixed
getContextValue(string $name)

Gets the value for a defined context.

from  ContextAwarePluginBase
$this
setContextValue(string $name, mixed $value)

Sets the value for a defined context.

from  ContextAwarePluginBase
ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

from  ContextAwarePluginBase
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

from  TypedDataTrait
TypedDataManagerInterface
getTypedDataManager()

Gets the typed data manager.

from  TypedDataTrait
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
array
getContextMapping()

Gets a mapping of the expected assignment names to their context names.

from  ContextAwarePluginBase
$this
setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

from  ContextAwarePluginBase
ContextHandlerInterface
contextHandler()

Wraps the context handler.

from  ContextAwarePluginBase
string[]
getCacheContexts()

The cache contexts associated with this object.

from  ContextAwarePluginBase
string[]
getCacheTags()

The cache tags associated with this object.

from  ContextAwarePluginBase
int
getCacheMaxAge()

The maximum age for which this object may be cached.

from  ContextAwarePluginBase
DataDefinitionInterface[]
getConfigDefinitions()

Gets an array of definitions of available configuration options.

DataDefinitionInterface|false
getConfigDefinition(string $key)

Gets the definition of a configuration option.

array
getConfig()

Gets all configuration values.

$this
setConfig(string $key, mixed $value)

Sets the value of a particular configuration option.

Details

in ContextAwarePluginBase at line 52
__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.

Parameters

array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin_id for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.

in PluginBase at line 66
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 73
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 84
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in PluginBase at line 96
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in PluginBase at line 106
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

in ContextAwarePluginBase at line 67
__get($name)

Implements magic __get() method.

Parameters

$name

in ContextAwarePluginBase at line 30
protected ContextInterface[] createContextFromConfiguration(array $context_configuration)

Creates context objects from any context mappings in configuration.

Parameters

array $context_configuration

An associative array of context names and values.

Return Value

ContextInterface[]

An array of context objects.

in ContextAwarePluginBase at line 105
ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

in ContextAwarePluginBase at line 114
ContextDefinitionInterface getContextDefinition(string $name)

Gets a specific context definition of the plugin.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextDefinitionInterface

The definition against which the context value must validate.

Exceptions

PluginException

in ContextAwarePluginBase at line 124
array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

PluginException

in ContextAwarePluginBase at line 50
ContextInterface getContext(string $name)

Gets a defined context.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextInterface

The context object.

Exceptions

PluginException

in ContextAwarePluginBase at line 61
setContext(string $name, ContextInterface $context)

Set a context on this plugin.

Parameters

string $name

The name of the context in the plugin configuration.
ContextInterface $context

The context object to set.

in ContextAwarePluginBase at line 153
array getContextValues()

Gets the values for all defined contexts.

Return Value

array

An array of set context values, keyed by context name. If a context is unset its value is returned as NULL.

in ContextAwarePluginBase at line 164
mixed getContextValue(string $name)

Gets the value for a defined context.

Parameters

string $name

The name of the context in the plugin configuration.

Return Value

mixed

The currently set context value.

Exceptions

PluginException

in ContextAwarePluginBase at line 72
$this setContextValue(string $name, mixed $value)

Sets the value for a defined context.

Parameters

string $name

The name of the context in the plugin definition.
mixed $value

The value to set the context to. The value has to validate against the provided context definition.

Return Value

$this

A context aware plugin object for chaining.

Exceptions

PluginException

in ContextAwarePluginBase at line 179
ConstraintViolationListInterface validateContexts()

Validates the set values for the defined contexts.

Return Value

ConstraintViolationListInterface

A list of constraint violations. If the list is empty, validation succeeded.

in TypedDataTrait at line 25
$this setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

Parameters

TypedDataManagerInterface $typed_data_manager

The typed data manager.

Return Value

$this

in TypedDataTrait at line 36
TypedDataManagerInterface getTypedDataManager()

Gets the typed data manager.

Return Value

TypedDataManagerInterface

The typed data manager.

in StringTranslationTrait at line 70
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

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

in DependencySerializationTrait at line 30
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 65
__wakeup()

{@inheritdoc}

in ContextAwarePluginBase at line 80
array getContextMapping()

Gets a mapping of the expected assignment names to their context names.

Return Value

array

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

in ContextAwarePluginBase at line 88
$this setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

Parameters

array $context_mapping

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

Return Value

$this

in ContextAwarePluginBase at line 123
protected ContextHandlerInterface contextHandler()

Wraps the context handler.

Return Value

ContextHandlerInterface

in ContextAwarePluginBase at line 130
string[] getCacheContexts()

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

Return Value

string[]

An array of cache context tokens, used to generate a cache ID.

in ContextAwarePluginBase at line 146
string[] getCacheTags()

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

Return Value

string[]

A set of cache tags.

in ContextAwarePluginBase at line 162
int getCacheMaxAge()

The maximum age for which this object may be cached.

Return Value

int

The maximum time in seconds that this object may be cached.

at line 22
DataDefinitionInterface[] getConfigDefinitions()

Gets an array of definitions of available configuration options.

Return Value

DataDefinitionInterface[]

An array of typed data definitions describing available configuration options, keyed by option name.

at line 42
DataDefinitionInterface|false getConfigDefinition(string $key)

Gets the definition of a configuration option.

Parameters

string $key

The key of the configuration option to get.

Return Value

DataDefinitionInterface|false

The typed data definition describing the configuration option, or FALSE if the option does not exist.

at line 59
array getConfig()

Gets all configuration values.

Return Value

array

The array of all configuration values, keyed by configuration option name.

at line 81
$this setConfig(string $key, mixed $value)

Sets the value of a particular configuration option.

This doesn't belong here. Move this into a new base class in https://www.drupal.org/node/1764380. This does not set a value in \Drupal::config(), so the name is confusing.

Parameters

string $key

The key of the configuration option to set.
mixed $value

The value to set.

Return Value

$this

The executable object for chaining.

Exceptions

PluginException