interface PluginHierarchyDefinitionInterface in Plugin 8.2

Defines a plugin definition that defines a parent plugin.

Hierarchy

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

2 files declare their use of PluginHierarchyDefinitionInterface

PluginHierarchyTrait.php in src/PluginHierarchyTrait.php

PluginHierarchyTraitTest.php in tests/src/Unit/PluginHierarchyTraitTest.php

File

src/PluginDefinition/PluginHierarchyDefinitionInterface.php, line 10

Namespace

Drupal\plugin\PluginDefinition

interface PluginHierarchyDefinitionInterface extends PluginDefinitionInterface {

  /**
   * Sets the ID of the parent plugin.
   *
   * @param string $id
   *   The ID.
   *
   * @return $this
   */
  public function setParentId($id);

  /**
   * Gets the ID of the parent plugin.
   *
   * @return string|null
   *   The ID or NULL if there is no parent.
   */
  public function getParentId();

}

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
PluginHierarchyDefinitionInterface::getParentId	public	function	Gets the ID of the parent plugin.	1
PluginHierarchyDefinitionInterface::setParentId	public	function	Sets the ID of the parent plugin.	1