Mercurial > hg > isophonics-drupal-site
annotate core/lib/Drupal/Component/Plugin/PluginInspectionInterface.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; |
Chris@0 | 4 |
Chris@0 | 5 /** |
Chris@0 | 6 * Plugin interface for providing some metadata inspection. |
Chris@0 | 7 * |
Chris@0 | 8 * This interface provides some simple tools for code receiving a plugin to |
Chris@0 | 9 * interact with the plugin system. |
Chris@0 | 10 * |
Chris@0 | 11 * @ingroup plugin_api |
Chris@0 | 12 */ |
Chris@0 | 13 interface PluginInspectionInterface { |
Chris@0 | 14 |
Chris@0 | 15 /** |
Chris@0 | 16 * Gets the plugin_id of the plugin instance. |
Chris@0 | 17 * |
Chris@0 | 18 * @return string |
Chris@0 | 19 * The plugin_id of the plugin instance. |
Chris@0 | 20 */ |
Chris@0 | 21 public function getPluginId(); |
Chris@0 | 22 |
Chris@0 | 23 /** |
Chris@0 | 24 * Gets the definition of the plugin implementation. |
Chris@0 | 25 * |
Chris@0 | 26 * @return array |
Chris@0 | 27 * The plugin definition, as returned by the discovery object used by the |
Chris@0 | 28 * plugin manager. |
Chris@0 | 29 */ |
Chris@0 | 30 public function getPluginDefinition(); |
Chris@0 | 31 |
Chris@0 | 32 } |