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

InfoHookDecorator

class InfoHookDecorator implements DiscoveryInterface (View source)

Allows info hook implementations to enhance discovered plugin definitions.

Traits

DiscoveryTrait

Properties

protected DiscoveryInterface $decorated

The Discovery object being decorated.
protected string $hook

The name of the info hook that will be implemented by this discovery instance.

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 $hook)

Constructs an InfoHookDecorator object.

__call($method, $args)

Passes through all unknown calls onto the decorated object.

Details

at line 45
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 37
__construct(DiscoveryInterface $decorated, string $hook)

Constructs an InfoHookDecorator object.

Parameters

DiscoveryInterface $decorated

The object implementing DiscoveryInterface that is being decorated.
string $hook

The name of the info hook to be invoked by this discovery instance.

at line 57
__call($method, $args)

Passes through all unknown calls onto the decorated object.

Parameters

$method
$args