1. interface
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. Definition
  9. \
  10. DerivablePluginDefinitionInterface

DerivablePluginDefinitionInterface

interface DerivablePluginDefinitionInterface implements PluginDefinitionInterface (View source)

Provides an interface for a derivable plugin definition.

Methods

string
id()

Gets the unique identifier of the plugin.

from  PluginDefinitionInterface
PluginDefinitionInterface
setClass(string $class)

Sets the class.

from  PluginDefinitionInterface
string
getClass()

Gets the class.

from  PluginDefinitionInterface
string
getProvider()

Gets the plugin provider.

from  PluginDefinitionInterface
string|null
getDeriver()

Gets the name of the deriver of this plugin definition, if it exists.

$this
setDeriver(string|null $deriver)

Sets the deriver of this plugin definition.

Details

in PluginDefinitionInterface at line 20
string id()

Gets the unique identifier of the plugin.

Return Value

string

The unique identifier of the plugin.

in PluginDefinitionInterface at line 33
PluginDefinitionInterface setClass(string $class)

Sets the class.

Parameters

string $class

A fully qualified class name.

Return Value

PluginDefinitionInterface

Exceptions

InvalidArgumentException

in PluginDefinitionInterface at line 41
string getClass()

Gets the class.

Return Value

string

A fully qualified class name.

in PluginDefinitionInterface at line 52
string getProvider()

Gets the plugin provider.

The provider is the name of the module that provides the plugin, or "core', or "component".

Return Value

string

The provider.

at line 18
string|null getDeriver()

Gets the name of the deriver of this plugin definition, if it exists.

Return Value

string|null

Either the deriver class name, or NULL if the plugin is not derived.

at line 29
$this setDeriver(string|null $deriver)

Sets the deriver of this plugin definition.

Parameters

string|null $deriver

Either the name of a class that implements \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL.

Return Value

$this