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

DerivativeDiscoveryDecorator

class DerivativeDiscoveryDecorator implements DiscoveryInterface (View source)

Base class providing the tools for a plugin discovery to be derivative aware.

Provides a decorator that allows the use of plugin derivatives for normal implementations DiscoveryInterface.

Traits

DiscoveryTrait

Properties

protected DeriverInterface[] $derivers

Plugin derivers.
protected DiscoveryInterface $decorated

The decorated plugin discovery.

Methods

array
getDefinitions()

Gets the definition of all plugins for this type.

mixed
getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

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)

Creates a new instance.

getDerivatives(array $base_plugin_definitions)

Adds derivatives to a list of plugin definitions.

array
decodePluginId(string $plugin_id)

Decodes derivative id and plugin id from a string.

string
encodePluginId(string $base_plugin_id, string $derivative_id)

Encodes plugin and derivative id's into a string.

DeriverInterface|null
getDeriver(string $base_plugin_id, mixed $base_definition)

Gets a deriver for a base plugin.

string|null
getDeriverClass(array $base_definition)

Gets the deriver class name from the base plugin definition.

array
mergeDerivativeDefinition(array $base_plugin_definition, array $derivative_definition)

Merges a base and derivative definition, taking into account empty values.

__call($method, $args)

Passes through all unknown calls onto the decorated object.

Details

at line 85
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 51
mixed getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

Parameters

string $plugin_id

A plugin id.
bool $exception_on_invalid

(optional) If TRUE, an invalid plugin ID will throw an exception.

Return Value

mixed

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

Exceptions

PluginNotFoundException

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 40
__construct(DiscoveryInterface $decorated)

Creates a new instance.

Parameters

DiscoveryInterface $decorated

The parent object implementing DiscoveryInterface that is being decorated.

at line 96
protected getDerivatives(array $base_plugin_definitions)

Adds derivatives to a list of plugin definitions.

This should be called by the class extending this in DiscoveryInterface::getDefinitions().

Parameters

array $base_plugin_definitions

at line 132
protected array decodePluginId(string $plugin_id)

Decodes derivative id and plugin id from a string.

Parameters

string $plugin_id

Plugin identifier that may point to a derivative plugin.

Return Value

array

An array with the base plugin id as the first index and the derivative id as the second. If there is no derivative id it will be null.

at line 154
protected string encodePluginId(string $base_plugin_id, string $derivative_id)

Encodes plugin and derivative id's into a string.

Parameters

string $base_plugin_id

The base plugin identifier.
string $derivative_id

The derivative identifier.

Return Value

string

A uniquely encoded combination of the $base_plugin_id and $derivative_id.

at line 179
protected DeriverInterface|null getDeriver(string $base_plugin_id, mixed $base_definition)

Gets a deriver for a base plugin.

Parameters

string $base_plugin_id

The base plugin id of the plugin.
mixed $base_definition

The base plugin definition to build derivatives.

Return Value

DeriverInterface|null

A DerivativeInterface or NULL if none exists for the plugin.

Exceptions

InvalidDeriverException

at line 205
protected string|null getDeriverClass(array $base_definition)

Gets the deriver class name from the base plugin definition.

Parameters

array $base_definition

The base plugin definition to build derivatives.

Return Value

string|null

The name of a class implementing \Drupal\Component\Plugin\Derivative\DeriverInterface.

Exceptions

InvalidDeriverException

at line 238
protected array mergeDerivativeDefinition(array $base_plugin_definition, array $derivative_definition)

Merges a base and derivative definition, taking into account empty values.

Parameters

array $base_plugin_definition

The base plugin definition.
array $derivative_definition

The derivative plugin definition.

Return Value

array

The merged definition.

at line 250
__call($method, $args)

Passes through all unknown calls onto the decorated object.

Parameters

$method
$args