interface PluginDescriptionDefinitionInterface in Plugin 8.2

Defines a plugin definition that includes a description.

Hierarchy

• interface \Drupal\Component\Plugin\Definition\PluginDefinitionInterface
  • interface \Drupal\plugin\PluginDefinition\PluginDefinitionInterface
    • interface \Drupal\plugin\PluginDefinition\PluginDescriptionDefinitionInterface

2 files declare their use of PluginDescriptionDefinitionInterface

ListPlugins.php in src/Controller/ListPlugins.php

ListPluginsTest.php in tests/src/Unit/Controller/ListPluginsTest.php

File

src/PluginDefinition/PluginDescriptionDefinitionInterface.php, line 10

Namespace

Drupal\plugin\PluginDefinition

interface PluginDescriptionDefinitionInterface extends PluginDefinitionInterface {

  /**
   * Sets the human-readable plugin description.
   *
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|string $description
   *   The description.
   *
   * @return $this
   */
  public function setDescription($description);

  /**
   * Gets the human-readable plugin description.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup|string|null
   *   The description or NULL if there is none.
   */
  public function getDescription();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginDefinitionInterface::getClass	public	function	Gets the class.	1
PluginDefinitionInterface::getId	public	function	Gets the plugin ID.	2
PluginDefinitionInterface::getProvider	public	function	Gets the plugin provider. Overrides PluginDefinitionInterface::getProvider	2
PluginDefinitionInterface::id	public	function	Gets the unique identifier of the plugin.	1
PluginDefinitionInterface::mergeDefaultDefinition	public	function	Merges another definition into this one, using the other for defaults.
PluginDefinitionInterface::mergeOverrideDefinition	public	function	Merges another definition into this one, using the other for overrides.
PluginDefinitionInterface::setClass	public	function	Sets the class.	1
PluginDefinitionInterface::setId	public	function	Sets the plugin ID.	2
PluginDefinitionInterface::setProvider	public	function	Sets the plugin provider.	2
PluginDescriptionDefinitionInterface::getDescription	public	function	Gets the human-readable plugin description.	1
PluginDescriptionDefinitionInterface::setDescription	public	function	Sets the human-readable plugin description.	1