Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 23 |
| ExecutablePluginBase | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
72 | |
0.00% |
0 / 23 |
| getConfigDefinitions | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 6 |
|||
| getConfigDefinition | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 6 |
|||
| getConfig | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| setConfig | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 9 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\Core\Executable\ExecutablePluginBase. | |
| */ | |
| namespace Drupal\Core\Executable; | |
| use Drupal\Core\Plugin\ContextAwarePluginBase; | |
| use Drupal\Component\Plugin\Exception\PluginException; | |
| /** | |
| * Provides the basic architecture for executable plugins. | |
| */ | |
| 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 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 | |
| * https://www.drupal.org/node/1764380. | |
| * @todo This does not set a value in \Drupal::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::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; | |
| } | |
| } | |