Provides the basic architecture for executable plugins.
Expanded class hierarchy of ExecutablePluginBase
abstract class ExecutablePluginBase extends ContextAwarePluginBase implements ExecutableInterface {
/**
* The condition manager to proxy execute calls through.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $executableManager;
/**
* {@inheritdoc}
*/
public function setExecutableManager(ExecutableManagerInterface $executableManager) {
$this->executableManager = $executableManager;
return $this;
}
/**
* Gets an array of definitions of available configuration options.
*
* @todo: This needs to go into an interface.
*
* @return array
* 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 array();
}
/**
* Gets the definition of a configuration option.
*
* @todo: This needs to go into an interface.
*
* @return array
* 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 $name
* The name 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
* http://drupal.org/node/1764380.
* @todo This does not set a value in config(), so the name is confusing.
*
* @return \Drupal\Core\Executable\ExecutablePluginBase.
* The executable object for chaining.
*/
public function setConfig($key, $value) {
if ($definition = $this
->getConfigDefinition($key)) {
$typed_data = \Drupal::typedData()
->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;
}
}