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

PluginDefinition

class PluginDefinition implements PluginDefinitionInterface (View source)

Provides object-based plugin definitions.

Properties

protected string $id

The plugin ID.
protected string $class

A fully qualified class name.
protected string $provider

The plugin provider.

Methods

string
id()

Gets the unique identifier of the plugin.

PluginDefinitionInterface
setClass(string $class)

Sets the class.

string
getClass()

Gets the class.

string
getProvider()

Gets the plugin provider.

Details

at line 34
string id()

Gets the unique identifier of the plugin.

Return Value

string

The unique identifier of the plugin.

at line 41
PluginDefinitionInterface setClass(string $class)

Sets the class.

Parameters

string $class

A fully qualified class name.

Return Value

PluginDefinitionInterface

Exceptions

InvalidArgumentException

at line 49
string getClass()

Gets the class.

Return Value

string

A fully qualified class name.

at line 56
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.