annotate core/lib/Drupal/Component/Plugin/ConfigurableInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 namespace Drupal\Component\Plugin;
Chris@18 4
Chris@18 5 /**
Chris@18 6 * Provides an interface for a configurable plugin.
Chris@18 7 *
Chris@18 8 * @ingroup plugin_api
Chris@18 9 */
Chris@18 10 interface ConfigurableInterface {
Chris@18 11
Chris@18 12 /**
Chris@18 13 * Gets this plugin's configuration.
Chris@18 14 *
Chris@18 15 * @return array
Chris@18 16 * An array of this plugin's configuration.
Chris@18 17 */
Chris@18 18 public function getConfiguration();
Chris@18 19
Chris@18 20 /**
Chris@18 21 * Sets the configuration for this plugin instance.
Chris@18 22 *
Chris@18 23 * @param array $configuration
Chris@18 24 * An associative array containing the plugin's configuration.
Chris@18 25 */
Chris@18 26 public function setConfiguration(array $configuration);
Chris@18 27
Chris@18 28 /**
Chris@18 29 * Gets default configuration for this plugin.
Chris@18 30 *
Chris@18 31 * @return array
Chris@18 32 * An associative array with the default configuration.
Chris@18 33 */
Chris@18 34 public function defaultConfiguration();
Chris@18 35
Chris@18 36 }