X-Git-Url: http://aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fcore%2Flib%2FDrupal%2FCore%2FExecutable%2FExecutablePluginBase.php;h=547724a50f6ff6ba313c7861356748f0db946fee;hb=refs%2Fheads%2Fd864;hp=0b758c60c713120f27280f60c6fd4dcad29dfcb5;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website diff --git a/web/core/lib/Drupal/Core/Executable/ExecutablePluginBase.php b/web/core/lib/Drupal/Core/Executable/ExecutablePluginBase.php index 0b758c60c..547724a50 100644 --- a/web/core/lib/Drupal/Core/Executable/ExecutablePluginBase.php +++ b/web/core/lib/Drupal/Core/Executable/ExecutablePluginBase.php @@ -15,7 +15,7 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex * * @todo: This needs to go into an interface. * - * @return array + * @return \Drupal\Core\TypedData\DataDefinitionInterface[] * An array of typed data definitions describing available configuration * options, keyed by option name. */ @@ -30,9 +30,12 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex /** * 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 array + * @return \Drupal\Core\TypedData\DataDefinitionInterface|false * The typed data definition describing the configuration option, or FALSE * if the option does not exist. */ @@ -60,8 +63,8 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex /** * Sets the value of a particular configuration option. * - * @param string $name - * The name of the configuration option to set. + * @param string $key + * The key of the configuration option to set. * @param mixed $value * The value to set. * @@ -71,6 +74,9 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex * * @return \Drupal\Core\Executable\ExecutablePluginBase * 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)) {