You are here

PluginInspectionInterface.php in Plug 7

File

lib/Drupal/Component/Plugin/PluginInspectionInterface.php
View source
<?php

/**
 * @file
 * Contains \Drupal\Component\Plugin\PluginInspectionInterface.
 */
namespace Drupal\Component\Plugin;


/**
 * Plugin interface for providing some metadata inspection.
 *
 * This interface provides some simple tools for code receiving a plugin to
 * interact with the plugin system.
 *
 * @ingroup plugin_api
 */
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();

}

Interfaces

Namesort descending Description
PluginInspectionInterface Plugin interface for providing some metadata inspection.