interface DerivablePluginDefinitionInterface

Same name in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php \Drupal\Component\Plugin\Definition\DerivablePluginDefinitionInterface
  2. 10 core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php \Drupal\Component\Plugin\Definition\DerivablePluginDefinitionInterface
  3. 11.x core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php \Drupal\Component\Plugin\Definition\DerivablePluginDefinitionInterface

Provides an interface for a derivable plugin definition.

Hierarchy

Expanded class hierarchy of DerivablePluginDefinitionInterface

All classes that implement DerivablePluginDefinitionInterface

See also

\Drupal\Component\Plugin\Derivative\DeriverInterface

3 files declare their use of DerivablePluginDefinitionInterface
DerivativeDiscoveryDecorator.php in core/lib/Drupal/Component/Plugin/Discovery/DerivativeDiscoveryDecorator.php
DerivativeDiscoveryDecoratorTest.php in core/tests/Drupal/Tests/Core/Plugin/Discovery/DerivativeDiscoveryDecoratorTest.php
LayoutDefinition.php in core/lib/Drupal/Core/Layout/LayoutDefinition.php

File

core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php, line 10

Namespace

Drupal\Component\Plugin\Definition
View source
interface DerivablePluginDefinitionInterface extends PluginDefinitionInterface {
    
    /**
     * Gets the name of the deriver of this plugin definition, if it exists.
     *
     * @return string|null
     *   Either the deriver class name, or NULL if the plugin is not derived.
     */
    public function getDeriver();
    
    /**
     * Sets the deriver of this plugin definition.
     *
     * @param string|null $deriver
     *   Either the name of a class that implements
     *   \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL.
     *
     * @return $this
     */
    public function setDeriver($deriver);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
DerivablePluginDefinitionInterface::getDeriver public function Gets the name of the deriver of this plugin definition, if it exists. 1
DerivablePluginDefinitionInterface::setDeriver public function Sets the deriver of this plugin definition. 1
PluginDefinitionInterface::getClass public function Gets the class. 1
PluginDefinitionInterface::getProvider public function Gets the plugin provider. 1
PluginDefinitionInterface::id public function Gets the unique identifier of the plugin. 1
PluginDefinitionInterface::setClass public function Sets the class. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.