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

DiscoveryCachedTrait

trait DiscoveryCachedTrait (View source)

Traits

DiscoveryTrait

Properties

protected array $definitions

Cached definitions array.

Methods

getDefinitions()

{@inheritdoc}

from  DiscoveryTrait
getDefinition($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

Details

in DiscoveryTrait at line 15
abstract getDefinitions()

{@inheritdoc}

at line 19
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