annotate core/lib/Drupal/Component/Plugin/ConfigurablePluginInterface.php @ 0:c75dbcec494b

Initial commit from drush-created site
author Chris Cannam
date Thu, 05 Jul 2018 14:24:15 +0000
parents
children 12f9dff5fda9
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\Plugin;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Provides an interface for a configurable plugin.
Chris@0 7 *
Chris@0 8 * @ingroup plugin_api
Chris@0 9 */
Chris@0 10 interface ConfigurablePluginInterface extends DependentPluginInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Gets this plugin's configuration.
Chris@0 14 *
Chris@0 15 * @return array
Chris@0 16 * An array of this plugin's configuration.
Chris@0 17 */
Chris@0 18 public function getConfiguration();
Chris@0 19
Chris@0 20 /**
Chris@0 21 * Sets the configuration for this plugin instance.
Chris@0 22 *
Chris@0 23 * @param array $configuration
Chris@0 24 * An associative array containing the plugin's configuration.
Chris@0 25 */
Chris@0 26 public function setConfiguration(array $configuration);
Chris@0 27
Chris@0 28 /**
Chris@0 29 * Gets default configuration for this plugin.
Chris@0 30 *
Chris@0 31 * @return array
Chris@0 32 * An associative array with the default configuration.
Chris@0 33 */
Chris@0 34 public function defaultConfiguration();
Chris@0 35
Chris@0 36 }