www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php

   1 <?php
   2
   3 namespace Drupal\Component\Plugin;
   4
   5 /**
   6  * Plugin interface for providing some metadata inspection.
   7  *
   8  * This interface provides some simple tools for code receiving a plugin to
   9  * interact with the plugin system.
  10  *
  11  * @ingroup plugin_api
  12  */
  13 interface PluginInspectionInterface {
  14
  15   /**
  16    * Gets the plugin_id of the plugin instance.
  17    *
  18    * @return string
  19    *   The plugin_id of the plugin instance.
  20    */
  21   public function getPluginId();
  22
  23   /**
  24    * Gets the definition of the plugin implementation.
  25    *
  26    * @return array
  27    *   The plugin definition, as returned by the discovery object used by the
  28    *   plugin manager.
  29    */
  30   public function getPluginDefinition();
  31
  32 }