Mercurial > hg > isophonics-drupal-site
annotate core/lib/Drupal/Component/Plugin/Definition/PluginDefinitionInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\Component\Plugin\Definition; |
Chris@0 | 4 |
Chris@0 | 5 /** |
Chris@0 | 6 * Defines a plugin definition. |
Chris@0 | 7 * |
Chris@0 | 8 * Object-based plugin definitions MUST implement this interface. |
Chris@0 | 9 * |
Chris@0 | 10 * @ingroup Plugin |
Chris@0 | 11 */ |
Chris@0 | 12 interface PluginDefinitionInterface { |
Chris@0 | 13 |
Chris@0 | 14 /** |
Chris@0 | 15 * Gets the unique identifier of the plugin. |
Chris@0 | 16 * |
Chris@0 | 17 * @return string |
Chris@0 | 18 * The unique identifier of the plugin. |
Chris@0 | 19 */ |
Chris@0 | 20 public function id(); |
Chris@0 | 21 |
Chris@0 | 22 /** |
Chris@0 | 23 * Sets the class. |
Chris@0 | 24 * |
Chris@0 | 25 * @param string $class |
Chris@0 | 26 * A fully qualified class name. |
Chris@0 | 27 * |
Chris@0 | 28 * @return static |
Chris@0 | 29 * |
Chris@0 | 30 * @throws \InvalidArgumentException |
Chris@0 | 31 * If the class is invalid. |
Chris@0 | 32 */ |
Chris@0 | 33 public function setClass($class); |
Chris@0 | 34 |
Chris@0 | 35 /** |
Chris@0 | 36 * Gets the class. |
Chris@0 | 37 * |
Chris@0 | 38 * @return string |
Chris@0 | 39 * A fully qualified class name. |
Chris@0 | 40 */ |
Chris@0 | 41 public function getClass(); |
Chris@0 | 42 |
Chris@0 | 43 /** |
Chris@0 | 44 * Gets the plugin provider. |
Chris@0 | 45 * |
Chris@0 | 46 * The provider is the name of the module that provides the plugin, or "core', |
Chris@0 | 47 * or "component". |
Chris@0 | 48 * |
Chris@0 | 49 * @return string |
Chris@0 | 50 * The provider. |
Chris@0 | 51 */ |
Chris@0 | 52 public function getProvider(); |
Chris@0 | 53 |
Chris@0 | 54 } |