interface PluginDefinitionDecoratorInterface in Plugin 8.2

Defines a plugin definition decorator.

As this interface cannot predict which plugin definitions its implementations can decorate, it is somewhat generic. When using this interface, developers are responsible for only using it with definitions that implementations support.

Hierarchy

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

File

src/PluginDefinition/PluginDefinitionDecoratorInterface.php, line 15

Namespace

Drupal\plugin\PluginDefinition

interface PluginDefinitionDecoratorInterface extends PluginDefinitionInterface {

  /**
   * Creates a new plugin definition that decorates another definition.
   *
   * @param mixed $decorated_plugin_definition
   *   The plugin definition to decorate. The supported types depend on the
   *   implementations of this method.
   *
   * @return static
   */
  public static function createFromDecoratedDefinition($decorated_plugin_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginDefinitionDecoratorInterface::createFromDecoratedDefinition	public static	function	Creates a new plugin definition that decorates another definition.	1
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