1. class
  2. Drupal
  3. \
  4. Component
  5. \
  6. Annotation
  7. \
  8. Plugin
  9. \
  10. Discovery
  11. \
  12. AnnotationBridgeDecorator

AnnotationBridgeDecorator

class AnnotationBridgeDecorator implements DiscoveryInterface (View source)

Ensures that all definitions are run through the annotation process.

Traits

DiscoveryTrait

Properties

protected DiscoveryInterface $decorated

The decorated plugin discovery.
protected string|null $pluginDefinitionAnnotationName

The name of the annotation that contains the plugin definition.

Methods

array
getDefinitions()

Gets the definition of all plugins for this type.

getDefinition($plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

from  DiscoveryTrait
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
__construct(DiscoveryInterface $decorated, string $plugin_definition_annotation_name)

ObjectDefinitionDiscoveryDecorator constructor.

mixed
__call(string $method, array $args)

Passes through all unknown calls onto the decorated object.

Details

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

in DiscoveryTrait at line 20
getDefinition($plugin_id, $exception_on_invalid = TRUE)

{@inheritdoc}

Parameters

$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

at line 39
__construct(DiscoveryInterface $decorated, string $plugin_definition_annotation_name)

ObjectDefinitionDiscoveryDecorator constructor.

Parameters

DiscoveryInterface $decorated

The discovery object that is being decorated.
string $plugin_definition_annotation_name

The name of the annotation that contains the plugin definition. The class corresponding to this name must implement \Drupal\Component\Annotation\AnnotationInterface.

at line 71
mixed __call(string $method, array $args)

Passes through all unknown calls onto the decorated object.

Parameters

string $method

The method to call on the decorated plugin discovery.
array $args

The arguments to send to the method.

Return Value

mixed

The method result.