interface PluginInspectionInterface

Plugin interface for providing some metadata inspection.

This interface provides some simple tools for code recieving a plugin to interact with the plugin system.

Hierarchy

Expanded class hierarchy of PluginInspectionInterface

All classes that implement PluginInspectionInterface

3 files declare their use of PluginInspectionInterface
LayoutInterface.php in drupal/core/modules/layout/lib/Drupal/layout/Plugin/LayoutInterface.php
Definition of Drupal\layout\Plugin\LayoutInterface.
PluginInterface.php in drupal/core/modules/views/lib/Drupal/views/Plugin/views/PluginInterface.php
Definition of Drupal\views\Plugin\PluginInterface.
PluginSettingsInterface.php in drupal/core/modules/field/lib/Drupal/field/Plugin/PluginSettingsInterface.php
Definition of Drupal\field\Plugin\PluginSettingsInterface.

File

drupal/core/lib/Drupal/Component/Plugin/PluginInspectionInterface.php, line 15
Definition of Drupal\Component\Plugin\PluginInspectionInterface.

Namespace

Drupal\Component\Plugin
View source
interface PluginInspectionInterface {

  /**
   * Returns the plugin_id of the plugin instance.
   *
   * @return string
   *   The plugin_id of the plugin instance.
   */
  public function getPluginId();

  /**
   * Returns the definition of the plugin implementation.
   *
   * @return array
   *   The plugin definition, as returned by the discovery object used by the
   *   plugin manager.
   */
  public function getDefinition();

}

Members

Namesort descending Modifiers Type Description Overrides
PluginInspectionInterface::getDefinition public function Returns the definition of the plugin implementation. 1
PluginInspectionInterface::getPluginId public function Returns the plugin_id of the plugin instance. 1