From ef78dcceff2373f42916f943c15c71caba821ae1 Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Mon, 5 May 2014 13:35:18 -0700
Subject: [PATCH] Issue #2252081 by Xano: Move implementation-specific docs out
of PluginFormInterface
---
core/lib/Drupal/Component/Plugin/PluginBase.php | 10 +++++++---
core/lib/Drupal/Core/Plugin/PluginFormInterface.php | 5 -----
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/core/lib/Drupal/Component/Plugin/PluginBase.php b/core/lib/Drupal/Component/Plugin/PluginBase.php
index 2b6d6f35f49e..beac3e96abcc 100644
--- a/core/lib/Drupal/Component/Plugin/PluginBase.php
+++ b/core/lib/Drupal/Component/Plugin/PluginBase.php
@@ -33,6 +33,13 @@ abstract class PluginBase implements PluginInspectionInterface, DerivativeInspec
/**
* Configuration information passed into the plugin.
*
+ * When using an interface like
+ * \Drupal\Component\Plugin\ConfigurablePluginInterface, this is where the
+ * configuration should be stored.
+ *
+ * Plugin configuration is optional, so plugin implementations must provide
+ * their own setters and getters.
+ *
* @var array
*/
protected $configuration;
@@ -89,7 +96,4 @@ public function getDerivativeId() {
public function getPluginDefinition() {
return $this->pluginDefinition;
}
-
- // Note: Plugin configuration is optional so its left to the plugin type to
- // require a getter as part of its interface.
}
diff --git a/core/lib/Drupal/Core/Plugin/PluginFormInterface.php b/core/lib/Drupal/Core/Plugin/PluginFormInterface.php
index e029bba9b6ba..9ca47e01d692 100644
--- a/core/lib/Drupal/Core/Plugin/PluginFormInterface.php
+++ b/core/lib/Drupal/Core/Plugin/PluginFormInterface.php
@@ -38,11 +38,6 @@ public function validateConfigurationForm(array &$form, array &$form_state);
/**
* Form submission handler.
*
- * To properly store submitted form values store them in $this->configuration.
- * @code
- * $this->configuration['some_value'] = $form_state['values']['some_value'];
- * @endcode
- *
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
--
GitLab