class ExecutablePluginBase
Same name in other branches
- 9 core/lib/Drupal/Core/Executable/ExecutablePluginBase.php \Drupal\Core\Executable\ExecutablePluginBase
- 10 core/lib/Drupal/Core/Executable/ExecutablePluginBase.php \Drupal\Core\Executable\ExecutablePluginBase
- 11.x core/lib/Drupal/Core/Executable/ExecutablePluginBase.php \Drupal\Core\Executable\ExecutablePluginBase
Provides the basic architecture for executable plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Executable\ExecutableInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
Expanded class hierarchy of ExecutablePluginBase
1 file declares its use of ExecutablePluginBase
- ConditionPluginBase.php in core/
lib/ Drupal/ Core/ Condition/ ConditionPluginBase.php
File
-
core/
lib/ Drupal/ Core/ Executable/ ExecutablePluginBase.php, line 11
Namespace
Drupal\Core\ExecutableView source
abstract class ExecutablePluginBase extends ContextAwarePluginBase implements ExecutableInterface {
/**
* Gets an array of definitions of available configuration options.
*
* @todo: This needs to go into an interface.
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of typed data definitions describing available configuration
* options, keyed by option name.
*/
public function getConfigDefinitions() {
$definition = $this->getPluginDefinition();
if (!empty($definition['configuration'])) {
return $definition['configuration'];
}
return [];
}
/**
* Gets the definition of a configuration option.
*
* @param string $key
* The key of the configuration option to get.
*
* @todo: This needs to go into an interface.
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface|false
* The typed data definition describing the configuration option, or FALSE
* if the option does not exist.
*/
public function getConfigDefinition($key) {
$definition = $this->getPluginDefinition();
if (!empty($definition['configuration'][$key])) {
return $definition['configuration'][$key];
}
return FALSE;
}
/**
* Gets all configuration values.
*
* @todo: This needs to go into an interface.
*
* @return array
* The array of all configuration values, keyed by configuration option
* name.
*/
public function getConfig() {
return $this->configuration;
}
/**
* Sets the value of a particular configuration option.
*
* @param string $key
* The key of the configuration option to set.
* @param mixed $value
* The value to set.
*
* @todo This doesn't belong here. Move this into a new base class in
* https://www.drupal.org/node/1764380.
* @todo This does not set a value in \Drupal::config(), so the name is confusing.
*
* @return $this
* The executable object for chaining.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* If the provided configuration value does not pass validation.
*/
public function setConfig($key, $value) {
if ($definition = $this->getConfigDefinition($key)) {
$typed_data = \Drupal::typedDataManager()->create($definition, $value);
if ($typed_data->validate()
->count() > 0) {
throw new PluginException("The provided configuration value does not pass validation.");
}
}
$this->configuration[$key] = $value;
return $this;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ContextAwarePluginBase::$context | protected | property | The data objects representing the context of this plugin. | |||
ContextAwarePluginBase::$contexts | Deprecated | private | property | Data objects representing the contexts passed in the plugin configuration. | ||
ContextAwarePluginBase::contextHandler | protected | function | Wraps the context handler. | |||
ContextAwarePluginBase::createContextFromConfiguration | protected | function | Overrides ContextAwarePluginBase::createContextFromConfiguration | |||
ContextAwarePluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | 3 | |
ContextAwarePluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
ContextAwarePluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | ||
ContextAwarePluginBase::getContext | public | function | This code is identical to the Component in order to pick up a different Context class. |
Overrides ContextAwarePluginBase::getContext | ||
ContextAwarePluginBase::getContextDefinition | public | function | Overrides ContextAwarePluginBase::getContextDefinition | |||
ContextAwarePluginBase::getContextDefinitions | public | function | Overrides ContextAwarePluginBase::getContextDefinitions | |||
ContextAwarePluginBase::getContextMapping | public | function | Gets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::getContextMapping | ||
ContextAwarePluginBase::getContexts | public | function | Gets the defined contexts. | Overrides ContextAwarePluginInterface::getContexts | ||
ContextAwarePluginBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginInterface::getContextValue | ||
ContextAwarePluginBase::getContextValues | public | function | Gets the values for all defined contexts. | Overrides ContextAwarePluginInterface::getContextValues | ||
ContextAwarePluginBase::setContext | public | function | Set a context on this plugin. | Overrides ContextAwarePluginBase::setContext | 2 | |
ContextAwarePluginBase::setContextMapping | public | function | Sets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::setContextMapping | ||
ContextAwarePluginBase::setContextValue | public | function | Sets the value for a defined context. | Overrides ContextAwarePluginBase::setContextValue | ||
ContextAwarePluginBase::validateContexts | public | function | Validates the set values for the defined contexts. | Overrides ContextAwarePluginInterface::validateContexts | ||
ContextAwarePluginBase::__construct | public | function | Overrides \Drupal\Component\Plugin\PluginBase::__construct(). | Overrides PluginBase::__construct | 4 | |
ContextAwarePluginBase::__get | public | function | Implements magic __get() method. | |||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
ExecutableInterface::execute | public | function | Executes the plugin. | 21 | ||
ExecutablePluginBase::getConfig | public | function | Gets all configuration values. | |||
ExecutablePluginBase::getConfigDefinition | public | function | Gets the definition of a configuration option. | |||
ExecutablePluginBase::getConfigDefinitions | public | function | Gets an array of definitions of available configuration options. | |||
ExecutablePluginBase::setConfig | public | function | Sets the value of a particular configuration option. | |||
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 | ||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
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. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | |||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | ||
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.