You are here

Home » API reference » Service Container 7 » PluginInspectionInterface.php

interface PluginInspectionInterface in Service Container 7

Same name and namespace in other branches
  1. 7.2 lib/Drupal/Component/Plugin/PluginInspectionInterface.php \Drupal\Component\Plugin\PluginInspectionInterface

Plugin interface for providing some metadata inspection.

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

Hierarchy

Expanded class hierarchy of PluginInspectionInterface

All classes that implement PluginInspectionInterface

File

lib/Drupal/Component/Plugin/PluginInspectionInterface.php, line 17
Contains \Drupal\Component\Plugin\PluginInspectionInterface.

Namespace

Drupal\Component\Plugin
View source 
interface PluginInspectionInterface {

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

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

}

Members

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