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

AnnotatedClassDiscovery

class AnnotatedClassDiscovery implements DiscoveryInterface (View source)

Defines a discovery mechanism to find annotated plugins in PSR-4 namespaces.

Traits

DiscoveryTrait

Properties

protected string[] $pluginNamespaces

The namespaces within which to find plugin classes.
protected string $pluginDefinitionAnnotationName

The name of the annotation that contains the plugin definition.
protected Reader $annotationReader

The doctrine annotation reader.
protected string[] $annotationNamespaces

Additional namespaces to be scanned for annotation classes.
protected FileCacheInterface $fileCache

The file cache object.

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(string[] $plugin_namespaces = [], string $plugin_definition_annotation_name = 'Drupal\\Component\\Annotation\\Plugin', array $annotation_namespaces = [])

Constructs a new instance.

Reader
getAnnotationReader()

Gets the used doctrine annotation reader.

prepareAnnotationDefinition(AnnotationInterface $annotation, string $class)

Prepares the annotation definition.

string[]
getPluginNamespaces()

Gets an array of PSR-4 namespaces to search for plugin classes.

Details

at line 107
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 72
__construct(string[] $plugin_namespaces = [], string $plugin_definition_annotation_name = 'Drupal\\Component\\Annotation\\Plugin', array $annotation_namespaces = [])

Constructs a new instance.

Parameters

string[] $plugin_namespaces

(optional) An array of namespace that may contain plugin implementations. Defaults to an empty array.
string $plugin_definition_annotation_name

(optional) The name of the annotation that contains the plugin definition. Defaults to 'Drupal\Component\Annotation\Plugin'.
array $annotation_namespaces

(optional) Additional namespaces to be scanned for annotation classes.

at line 88
protected Reader getAnnotationReader()

Gets the used doctrine annotation reader.

Return Value

Reader

The annotation reader.

at line 178
protected prepareAnnotationDefinition(AnnotationInterface $annotation, string $class)

Prepares the annotation definition.

Parameters

AnnotationInterface $annotation

The annotation derived from the plugin.
string $class

The class used for the plugin.

at line 187
protected string[] getPluginNamespaces()

Gets an array of PSR-4 namespaces to search for plugin classes.

Return Value

string[]