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

StaticDiscoveryDecorator

class StaticDiscoveryDecorator extends StaticDiscovery (View source)

A decorator that allows manual registration of undiscoverable definitions.

Traits

DiscoveryCachedTrait
DiscoveryTrait

Properties

protected array $definitions

Cached definitions array.

 from  DiscoveryCachedTrait
protected DiscoveryInterface $decorated

The Discovery object being decorated.
protected Callable $registerDefinitions

A callback or closure used for registering additional definitions.

Methods

array
getDefinitions()

Gets the definition of all plugins for this type.

getDefinition($base_plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

array|null
doGetDefinition(array $definitions, string $plugin_id, bool $exception_on_invalid)

Gets a specific plugin definition.

from  DiscoveryTrait
hasDefinition($plugin_id)

{@inheritdoc}

from  DiscoveryTrait
setDefinition($plugin, $definition)

Sets a plugin definition.

from  StaticDiscovery
deleteDefinition($plugin)

Deletes a plugin definition.

from  StaticDiscovery
__construct(DiscoveryInterface $decorated, Callable $registerDefinitions = NULL)

Constructs a \Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator object.

__call($method, $args)

Passes through all unknown calls onto the decorated object.

Details

at line 52
array getDefinitions()

Gets the definition of all plugins for this type.

Return Value

array

An array of plugin definitions (empty array if no definitions were found). Keys are plugin IDs.

at line 41
getDefinition($base_plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

Parameters

$base_plugin_id
$exception_on_invalid

in DiscoveryTrait at line 43
protected array|null doGetDefinition(array $definitions, string $plugin_id, bool $exception_on_invalid)

Gets a specific plugin definition.

Parameters

array $definitions

An array of the available plugin definitions.
string $plugin_id

A plugin id.
bool $exception_on_invalid

If TRUE, an invalid plugin ID will cause an exception to be thrown; if FALSE, NULL will be returned.

Return Value

array|null

A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is TRUE.

Exceptions

PluginNotFoundException

in DiscoveryTrait at line 59
hasDefinition($plugin_id)

{@inheritdoc}

Parameters

$plugin_id

in StaticDiscovery at line 26
setDefinition($plugin, $definition)

Sets a plugin definition.

Parameters

$plugin
$definition

in StaticDiscovery at line 33
deleteDefinition($plugin)

Deletes a plugin definition.

Parameters

$plugin

at line 33
__construct(DiscoveryInterface $decorated, Callable $registerDefinitions = NULL)

Constructs a \Drupal\Component\Plugin\Discovery\StaticDiscoveryDecorator object.

Parameters

DiscoveryInterface $decorated

The discovery object that is being decorated.
Callable $registerDefinitions

(optional) A callback or closure used for registering additional definitions.

at line 63
__call($method, $args)

Passes through all unknown calls onto the decorated object.

Parameters

$method
$args