interface AnnotatedPluginInterface in Markdown 8.2

Interface for annotated plugins.

@method \Drupal\markdown\Annotation\AnnotationObject getPluginDefinition()

@todo Move upstream to https://www.drupal.org/project/installable_plugins.

Hierarchy

• interface \Drupal\markdown\BcSupport\ConfigurableInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\markdown\Plugin\Markdown\AnnotatedPluginInterface extends \Symfony\Component\DependencyInjection\ContainerAwareInterface

File

src/Plugin/Markdown/AnnotatedPluginInterface.php, line 17

Namespace

Drupal\markdown\Plugin\Markdown

interface AnnotatedPluginInterface extends ConfigurableInterface, ContainerAwareInterface, ContainerFactoryPluginInterface, PluginInspectionInterface {

  /**
   * Retrieves the configuration overrides for the plugin.
   *
   * @param array $configuration
   *   Optional. Specific configuration to check. If not set, the currently
   *   set configuration will be used.
   *
   * @return array
   *   An array of configuration overrides.
   */
  public function getConfigurationOverrides(array $configuration = NULL);

  /**
   * Retrieves the description of the plugin, if set.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The description.
   */
  public function getDescription();

  /**
   * Displays the human-readable label of the plugin.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The label.
   */
  public function getLabel();

  /**
   * Retrieves the original plugin identifier.
   *
   * This is the identifier that was initially called, but may have changed
   * to the fallback identifier because it didn't exist.
   *
   * @return string
   *   The original plugin identifier.
   */
  public function getOriginalPluginId();

  /**
   * Returns the provider (extension name) of the plugin.
   *
   * @return string
   *   The provider of the plugin.
   */
  public function getProvider();

  /**
   * Returns the weight of the plugin (used for sorting).
   *
   * @return int
   *   The plugin weight.
   */
  public function getWeight();

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotatedPluginInterface::getConfigurationOverrides	public	function	Retrieves the configuration overrides for the plugin.	1
AnnotatedPluginInterface::getDescription	public	function	Retrieves the description of the plugin, if set.	1
AnnotatedPluginInterface::getLabel	public	function	Displays the human-readable label of the plugin.	2
AnnotatedPluginInterface::getOriginalPluginId	public	function	Retrieves the original plugin identifier.	1
AnnotatedPluginInterface::getProvider	public	function	Returns the provider (extension name) of the plugin.	1
AnnotatedPluginInterface::getWeight	public	function	Returns the weight of the plugin (used for sorting).	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	1
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2