From c9d53fd473acc154b0404e906c23f352097af6cd Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Thu, 4 Apr 2024 00:40:51 +0100
Subject: [PATCH] Issue #3424509 by godotislate, quietone, sorlov, smustgrave,
benjifisher, alexpott: Update MigratePluginManager to include both attribute
and annotation class
---
.../AttributeDiscoveryWithAnnotations.php | 4 +-
.../src/Plugin/migrate/destination/Book.php | 7 +-
.../src/Plugin/migrate/field/DateField.php | 24 ++---
.../Plugin/migrate/destination/EntityFile.php | 6 +-
core/modules/migrate/migrate.api.php | 19 ++--
core/modules/migrate/migrate.services.yml | 8 +-
.../src/Attribute/MigrateDestination.php | 53 +++++++++++
.../migrate/src/Attribute/MigrateProcess.php | 50 ++++++++++
.../migrate/src/Attribute/MigrateSource.php | 93 +++++++++++++++++++
.../MultipleProviderAttributeInterface.php | 44 +++++++++
...otatedClassDiscoveryAutomatedProviders.php | 29 +-----
...otatedDiscoveryAutomatedProvidersTrait.php | 59 ++++++++++++
...ributeClassDiscoveryAutomatedProviders.php | 42 +++++++++
...overyWithAnnotationsAutomatedProviders.php | 83 +++++++++++++++++
.../Plugin/MigrateDestinationInterface.php | 2 +-
.../MigrateDestinationPluginManager.php | 10 +-
.../src/Plugin/MigratePluginManager.php | 18 +++-
.../src/Plugin/MigrateProcessInterface.php | 2 +-
.../src/Plugin/MigrateSourceInterface.php | 2 +-
.../src/Plugin/MigrateSourcePluginManager.php | 33 ++++++-
.../migrate/destination/DestinationBase.php | 2 +-
.../src/Plugin/migrate/id_map/NullIdMap.php | 4 +-
.../migrate/src/Plugin/migrate/id_map/Sql.php | 4 +-
.../src/Plugin/migrate/process/Explode.php | 6 +-
.../migrate/source/EmbeddedDataSource.php | 10 +-
.../src/Plugin/migrate/source/EmptySource.php | 11 ++-
.../migrate/source/SourcePluginBase.php | 2 +-
.../modules/migrate/src/ProcessPluginBase.php | 2 +-
...migrate_source_annotation_bc_test.info.yml | 5 +
.../source/MigrateSourceWithAnnotations.php | 50 ++++++++++
...SourceWithAnnotationsMultipleProviders.php | 29 ++++++
.../MigrateSourceAnnotationDiscoveryTest.php | 60 ++++++++++++
.../migrate_drupal.services.yml | 1 +
.../src/Attribute/MigrateField.php | 74 +++++++++++++++
.../src/Plugin/MigrateFieldPluginManager.php | 4 +-
.../Plugin/migrate/field/FieldPluginBase.php | 2 +-
.../Plugin/migrate/source/ContentEntity.php | 14 +--
37 files changed, 763 insertions(+), 105 deletions(-)
create mode 100644 core/modules/migrate/src/Attribute/MigrateDestination.php
create mode 100644 core/modules/migrate/src/Attribute/MigrateProcess.php
create mode 100644 core/modules/migrate/src/Attribute/MigrateSource.php
create mode 100644 core/modules/migrate/src/Attribute/MultipleProviderAttributeInterface.php
create mode 100644 core/modules/migrate/src/Plugin/Discovery/AnnotatedDiscoveryAutomatedProvidersTrait.php
create mode 100644 core/modules/migrate/src/Plugin/Discovery/AttributeClassDiscoveryAutomatedProviders.php
create mode 100644 core/modules/migrate/src/Plugin/Discovery/AttributeDiscoveryWithAnnotationsAutomatedProviders.php
create mode 100644 core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/migrate_source_annotation_bc_test.info.yml
create mode 100644 core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotations.php
create mode 100644 core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotationsMultipleProviders.php
create mode 100644 core/modules/migrate/tests/src/Kernel/Plugin/source/MigrateSourceAnnotationDiscoveryTest.php
create mode 100644 core/modules/migrate_drupal/src/Attribute/MigrateField.php
diff --git a/core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php b/core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php
index a54e86087552..e4d2a51a8533 100644
--- a/core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php
+++ b/core/lib/Drupal/Core/Plugin/Discovery/AttributeDiscoveryWithAnnotations.php
@@ -114,7 +114,7 @@ protected function parseClass(string $class, \SplFileInfo $fileinfo): array {
* @see \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery::prepareAnnotationDefinition()
* @see \Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery::prepareAnnotationDefinition()
*/
- private function prepareAnnotationDefinition(AnnotationInterface $annotation, string $class): void {
+ protected function prepareAnnotationDefinition(AnnotationInterface $annotation, string $class): void {
$annotation->setClass($class);
if (!$annotation->getProvider()) {
$annotation->setProvider($this->getProviderFromNamespace($class));
@@ -133,7 +133,7 @@ private function prepareAnnotationDefinition(AnnotationInterface $annotation, st
* @see \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery::getAnnotationReader()
* @see \Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery::getAnnotationReader()
*/
- private function getAnnotationReader() : SimpleAnnotationReader {
+ protected function getAnnotationReader() : SimpleAnnotationReader {
if (!isset($this->annotationReader)) {
$this->annotationReader = new SimpleAnnotationReader();
diff --git a/core/modules/book/src/Plugin/migrate/destination/Book.php b/core/modules/book/src/Plugin/migrate/destination/Book.php
index dcc5056c89af..2f4ea3349066 100644
--- a/core/modules/book/src/Plugin/migrate/destination/Book.php
+++ b/core/modules/book/src/Plugin/migrate/destination/Book.php
@@ -3,15 +3,14 @@
namespace Drupal\book\Plugin\migrate\destination;
use Drupal\Core\Entity\EntityInterface;
+use Drupal\migrate\Attribute\MigrateDestination;
use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;
use Drupal\migrate\Row;
/**
- * @MigrateDestination(
- * id = "book",
- * provider = "book"
- * )
+ * Provides migrate destination plugin for Book content.
*/
+#[MigrateDestination('book')]
class Book extends EntityContentBase {
/**
diff --git a/core/modules/datetime/src/Plugin/migrate/field/DateField.php b/core/modules/datetime/src/Plugin/migrate/field/DateField.php
index f6a33434d15b..9bfa3572e31e 100644
--- a/core/modules/datetime/src/Plugin/migrate/field/DateField.php
+++ b/core/modules/datetime/src/Plugin/migrate/field/DateField.php
@@ -6,25 +6,25 @@
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\MigrateException;
use Drupal\migrate\Row;
+use Drupal\migrate_drupal\Attribute\MigrateField;
use Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase;
// cspell:ignore todate
/**
* Provides a field plugin for date and time fields.
- *
- * @MigrateField(
- * id = "datetime",
- * type_map = {
- * "date" = "datetime",
- * "datestamp" = "timestamp",
- * "datetime" = "datetime",
- * },
- * core = {6,7},
- * source_module = "date",
- * destination_module = "datetime"
- * )
*/
+#[MigrateField(
+ id: 'datetime',
+ core: [6, 7],
+ type_map: [
+ 'date' => 'datetime',
+ 'datestamp' => 'timestamp',
+ 'datetime' => 'datetime',
+ ],
+ source_module: 'date',
+ destination_module: 'datetime',
+)]
class DateField extends FieldPluginBase {
/**
diff --git a/core/modules/file/src/Plugin/migrate/destination/EntityFile.php b/core/modules/file/src/Plugin/migrate/destination/EntityFile.php
index 08b946f53f9a..c953a71869a9 100644
--- a/core/modules/file/src/Plugin/migrate/destination/EntityFile.php
+++ b/core/modules/file/src/Plugin/migrate/destination/EntityFile.php
@@ -3,15 +3,15 @@
namespace Drupal\file\Plugin\migrate\destination;
use Drupal\Core\Field\Plugin\Field\FieldType\UriItem;
+use Drupal\migrate\Attribute\MigrateDestination;
use Drupal\migrate\Row;
use Drupal\migrate\MigrateException;
use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;
/**
- * @MigrateDestination(
- * id = "entity:file"
- * )
+ * Provides migrate destination plugin for File entities.
*/
+#[MigrateDestination('entity:file')]
class EntityFile extends EntityContentBase {
/**
diff --git a/core/modules/migrate/migrate.api.php b/core/modules/migrate/migrate.api.php
index 0339475ff0f7..9b3ab67bb980 100644
--- a/core/modules/migrate/migrate.api.php
+++ b/core/modules/migrate/migrate.api.php
@@ -47,8 +47,8 @@
* @section sec_source Migrate API source plugins
* Migrate API source plugins implement
* \Drupal\migrate\Plugin\MigrateSourceInterface and usually extend
- * \Drupal\migrate\Plugin\migrate\source\SourcePluginBase. They are annotated
- * with \Drupal\migrate\Annotation\MigrateSource annotation and must be in
+ * \Drupal\migrate\Plugin\migrate\source\SourcePluginBase. They have the
+ * \Drupal\migrate\Attribute\MigrateSource attribute and must be in
* namespace subdirectory 'Plugin\migrate\source' under the namespace of the
* module that defines them. Migrate API source plugins are managed by the
* \Drupal\migrate\Plugin\MigrateSourcePluginManager class.
@@ -59,8 +59,8 @@
* @section sec_process Migrate API process plugins
* Migrate API process plugins implement
* \Drupal\migrate\Plugin\MigrateProcessInterface and usually extend
- * \Drupal\migrate\ProcessPluginBase. They are annotated with
- * \Drupal\migrate\Annotation\MigrateProcessPlugin annotation and must be in
+ * \Drupal\migrate\ProcessPluginBase. They have the
+ * \Drupal\migrate\Attribute\MigrateProcess attribute and must be in
* namespace subdirectory 'Plugin\migrate\process' under the namespace of the
* module that defines them. Migrate API process plugins are managed by the
* \Drupal\migrate\Plugin\MigratePluginManager class.
@@ -70,12 +70,11 @@
* @section sec_destination Migrate API destination plugins
* Migrate API destination plugins implement
* \Drupal\migrate\Plugin\MigrateDestinationInterface and usually extend
- * \Drupal\migrate\Plugin\migrate\destination\DestinationBase. They are
- * annotated with \Drupal\migrate\Annotation\MigrateDestination annotation and
- * must be in namespace subdirectory 'Plugin\migrate\destination' under the
- * namespace of the module that defines them. Migrate API destination plugins
- * are managed by the \Drupal\migrate\Plugin\MigrateDestinationPluginManager
- * class.
+ * \Drupal\migrate\Plugin\migrate\destination\DestinationBase. They have the
+ * \Drupal\migrate\Attribute\MigrateDestination attribute and must be in
+ * namespace subdirectory 'Plugin\migrate\destination' under the namespace of
+ * the module that defines them. Migrate API destination plugins are managed by
+ * the \Drupal\migrate\Plugin\MigrateDestinationPluginManager class.
*
* @link https://api.drupal.org/api/drupal/namespace/Drupal!migrate!Plugin!migrate!destination List of destination plugins for Drupal configuration and content entities provided by the core Migrate module. @endlink
*
diff --git a/core/modules/migrate/migrate.services.yml b/core/modules/migrate/migrate.services.yml
index d7ef2ded4b0d..b7068cf68250 100644
--- a/core/modules/migrate/migrate.services.yml
+++ b/core/modules/migrate/migrate.services.yml
@@ -14,7 +14,13 @@ services:
arguments: [source, '@container.namespaces', '@cache.discovery', '@module_handler']
plugin.manager.migrate.process:
class: Drupal\migrate\Plugin\MigratePluginManager
- arguments: [process, '@container.namespaces', '@cache.discovery', '@module_handler', 'Drupal\migrate\Annotation\MigrateProcessPlugin']
+ arguments:
+ - process
+ - '@container.namespaces'
+ - '@cache.discovery'
+ - '@module_handler'
+ - 'Drupal\migrate\Attribute\MigrateProcess'
+ - 'Drupal\migrate\Annotation\MigrateProcessPlugin'
plugin.manager.migrate.destination:
class: Drupal\migrate\Plugin\MigrateDestinationPluginManager
arguments: [destination, '@container.namespaces', '@cache.discovery', '@module_handler', '@entity_type.manager']
diff --git a/core/modules/migrate/src/Attribute/MigrateDestination.php b/core/modules/migrate/src/Attribute/MigrateDestination.php
new file mode 100644
index 000000000000..54e469b13814
--- /dev/null
+++ b/core/modules/migrate/src/Attribute/MigrateDestination.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+
+/**
+ * Defines a MigrateDestination attribute.
+ *
+ * Plugin Namespace: Plugin\migrate\destination
+ *
+ * For a working example, see
+ * \Drupal\migrate\Plugin\migrate\destination\UrlAlias
+ *
+ * @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
+ * @see \Drupal\migrate\Plugin\MigrateDestinationInterface
+ * @see \Drupal\migrate\Plugin\migrate\destination\DestinationBase
+ * @see \Drupal\migrate\Attribute\MigrateProcess
+ * @see \Drupal\migrate\Attribute\MigrateSource
+ * @see plugin_api
+ *
+ * @ingroup migration
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class MigrateDestination extends Plugin {
+
+ /**
+ * Constructs a migrate destination plugin attribute object.
+ *
+ * @param string $id
+ * A unique identifier for the destination plugin.
+ * @param bool $requirements_met
+ * (optional) Whether requirements are met.
+ * @param string|null $destination_module
+ * (optional) Identifies the system handling the data the destination plugin
+ * will write. The destination plugin itself determines how the value is
+ * used. For example, Migrate's destination plugins expect
+ * destination_module to be the name of a module that must be installed on
+ * the destination.
+ * @param class-string|null $deriver
+ * (optional) The deriver class.
+ */
+ public function __construct(
+ public readonly string $id,
+ public bool $requirements_met = TRUE,
+ public readonly ?string $destination_module = NULL,
+ public readonly ?string $deriver = NULL,
+ ) {
+ }
+
+}
diff --git a/core/modules/migrate/src/Attribute/MigrateProcess.php b/core/modules/migrate/src/Attribute/MigrateProcess.php
new file mode 100644
index 000000000000..ba2cb65cd147
--- /dev/null
+++ b/core/modules/migrate/src/Attribute/MigrateProcess.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+
+/**
+ * Defines a MigrateProcess attribute.
+ *
+ * Plugin Namespace: Plugin\migrate\process
+ *
+ * For a working example, see
+ * \Drupal\migrate\Plugin\migrate\process\DefaultValue
+ *
+ * @see \Drupal\migrate\Plugin\MigratePluginManager
+ * @see \Drupal\migrate\Plugin\MigrateProcessInterface
+ * @see \Drupal\migrate\ProcessPluginBase
+ * @see \Drupal\migrate\Attribute\MigrateDestination
+ * @see \Drupal\migrate\Attribute\MigrateSource
+ * @see plugin_api
+ *
+ * @ingroup migration
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class MigrateProcess extends Plugin {
+
+ /**
+ * Constructs a migrate process plugin attribute object.
+ *
+ * @param string $id
+ * A unique identifier for the process plugin.
+ * @param bool $handle_multiples
+ * (optional) Whether the plugin handles multiples itself. Typically these
+ * plugins will expect an array as input and iterate over it themselves,
+ * changing the whole array. For example the 'sub_process' and the 'flatten'
+ * plugins. If the plugin only needs to change a single value, then it can
+ * skip setting this attribute and let
+ * \Drupal\migrate\MigrateExecutable::processRow() handle the iteration.
+ * @param class-string|null $deriver
+ * (optional) The deriver class.
+ */
+ public function __construct(
+ public readonly string $id,
+ public readonly bool $handle_multiples = FALSE,
+ public readonly ?string $deriver = NULL,
+ ) {}
+
+}
diff --git a/core/modules/migrate/src/Attribute/MigrateSource.php b/core/modules/migrate/src/Attribute/MigrateSource.php
new file mode 100644
index 000000000000..1dd690035063
--- /dev/null
+++ b/core/modules/migrate/src/Attribute/MigrateSource.php
@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+
+/**
+ * Defines a MigrateSource attribute.
+ *
+ * Plugin Namespace: Plugin\migrate\source
+ *
+ * For a working example, see
+ * \Drupal\migrate\Plugin\migrate\source\EmptySource
+ * \Drupal\migrate_drupal\Plugin\migrate\source\UrlAlias
+ *
+ * @see \Drupal\migrate\Plugin\MigratePluginManager
+ * @see \Drupal\migrate\Plugin\MigrateSourceInterface
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ * @see \Drupal\migrate\Attribute\MigrateDestination
+ * @see \Drupal\migrate\Attribute\MigrateProcess
+ * @see plugin_api
+ *
+ * @ingroup migration
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class MigrateSource extends Plugin implements MultipleProviderAttributeInterface {
+
+ /**
+ * The providers of the source plugin.
+ */
+ protected array $providers = [];
+
+ /**
+ * Constructs a migrate source plugin attribute object.
+ *
+ * @param string $id
+ * A unique identifier for the source plugin.
+ * @param string $source_module
+ * Identifies the system providing the data the source plugin will read.
+ * @param bool $requirements_met
+ * (optional) Whether requirements are met. Defaults to true. The source
+ * plugin itself determines how the value is used. For example, Migrate
+ * Drupal's source plugins expect source_module to be the name of a module
+ * that must be installed and enabled in the source database.
+ * @param mixed $minimum_version
+ * (optional) Specifies the minimum version of the source provider. This can
+ * be any type, and the source plugin itself determines how it is used. For
+ * example, Migrate Drupal's source plugins expect this to be an integer
+ * representing the minimum installed database schema version of the module
+ * specified by source_module.
+ * @param class-string|null $deriver
+ * (optional) The deriver class.
+ *
+ * @see \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase::checkRequirements
+ */
+ public function __construct(
+ public readonly string $id,
+ public readonly string $source_module,
+ public bool $requirements_met = TRUE,
+ public readonly mixed $minimum_version = '',
+ public readonly ?string $deriver = NULL,
+ ) {}
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setProvider(string $provider): void {
+ $this->setProviders([$provider]);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getProviders(): array {
+ return $this->providers;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function setProviders(array $providers): void {
+ if ($providers) {
+ parent::setProvider(reset($providers));
+ }
+ else {
+ $this->provider = NULL;
+ }
+ $this->providers = $providers;
+ }
+
+}
diff --git a/core/modules/migrate/src/Attribute/MultipleProviderAttributeInterface.php b/core/modules/migrate/src/Attribute/MultipleProviderAttributeInterface.php
new file mode 100644
index 000000000000..437ddfb8b9ae
--- /dev/null
+++ b/core/modules/migrate/src/Attribute/MultipleProviderAttributeInterface.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Attribute;
+
+use Drupal\Component\Plugin\Attribute\AttributeInterface;
+
+/**
+ * Defines a common interface for attributes with multiple providers.
+ *
+ * @internal
+ * This is a temporary solution to the fact that migration source plugins have
+ * more than one provider. This functionality will be moved to core in
+ * https://www.drupal.org/node/2786355.
+ */
+interface MultipleProviderAttributeInterface extends AttributeInterface {
+
+ /**
+ * Gets the name of the provider of the attribute class.
+ *
+ * @return string|null
+ * The provider of the attribute. If there are multiple providers the first
+ * is returned.
+ */
+ public function getProvider(): ?string;
+
+ /**
+ * Gets the provider names of the attribute class.
+ *
+ * @return string[]
+ * The providers of the attribute.
+ */
+ public function getProviders(): array;
+
+ /**
+ * Sets the provider names of the attribute class.
+ *
+ * @param string[] $providers
+ * The providers of the attribute.
+ */
+ public function setProviders(array $providers): void;
+
+}
diff --git a/core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php b/core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php
index c51468911645..edea32fefda2 100644
--- a/core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php
+++ b/core/modules/migrate/src/Plugin/Discovery/AnnotatedClassDiscoveryAutomatedProviders.php
@@ -3,12 +3,10 @@
namespace Drupal\migrate\Plugin\Discovery;
use Doctrine\Common\Annotations\AnnotationRegistry;
-use Drupal\Component\Annotation\AnnotationInterface;
use Drupal\Component\Annotation\Doctrine\StaticReflectionParser as BaseStaticReflectionParser;
use Drupal\Component\Annotation\Reflection\MockFileFinder;
use Drupal\Component\ClassFinder\ClassFinder;
use Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery;
-use Drupal\migrate\Annotation\MultipleProviderAnnotationInterface;
/**
* Determines providers based on a class's and its parent's namespaces.
@@ -20,12 +18,7 @@
*/
class AnnotatedClassDiscoveryAutomatedProviders extends AnnotatedClassDiscovery {
- /**
- * A utility object that can use active autoloaders to find files for classes.
- *
- * @var \Drupal\Component\ClassFinder\ClassFinderInterface
- */
- protected $finder;
+ use AnnotatedDiscoveryAutomatedProvidersTrait;
/**
* Constructs an AnnotatedClassDiscoveryAutomatedProviders object.
@@ -48,26 +41,6 @@ public function __construct($subdir, \Traversable $root_namespaces, $plugin_defi
$this->finder = new ClassFinder();
}
- /**
- * {@inheritdoc}
- */
- protected function prepareAnnotationDefinition(AnnotationInterface $annotation, $class, BaseStaticReflectionParser $parser = NULL) {
- if (!($annotation instanceof MultipleProviderAnnotationInterface)) {
- throw new \LogicException('AnnotatedClassDiscoveryAutomatedProviders annotations must implement \Drupal\migrate\Annotation\MultipleProviderAnnotationInterface');
- }
- $annotation->setClass($class);
- $providers = $annotation->getProviders();
- // Loop through all the parent classes and add their providers (which we
- // infer by parsing their namespaces) to the $providers array.
- do {
- $providers[] = $this->getProviderFromNamespace($parser->getNamespaceName());
- } while ($parser = StaticReflectionParser::getParentParser($parser, $this->finder));
- $providers = array_unique(array_filter($providers, function ($provider) {
- return $provider && $provider !== 'component';
- }));
- $annotation->setProviders($providers);
- }
-
/**
* {@inheritdoc}
*/
diff --git a/core/modules/migrate/src/Plugin/Discovery/AnnotatedDiscoveryAutomatedProvidersTrait.php b/core/modules/migrate/src/Plugin/Discovery/AnnotatedDiscoveryAutomatedProvidersTrait.php
new file mode 100644
index 000000000000..aa9d8745a677
--- /dev/null
+++ b/core/modules/migrate/src/Plugin/Discovery/AnnotatedDiscoveryAutomatedProvidersTrait.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace Drupal\migrate\Plugin\Discovery;
+
+use Drupal\Component\Annotation\AnnotationInterface;
+use Drupal\Component\Annotation\Doctrine\StaticReflectionParser as BaseStaticReflectionParser;
+use Drupal\migrate\Annotation\MultipleProviderAnnotationInterface;
+
+/**
+ * Provides method for annotation discovery with multiple providers.
+ */
+trait AnnotatedDiscoveryAutomatedProvidersTrait {
+
+ /**
+ * A utility object that can use active autoloaders to find files for classes.
+ *
+ * @var \Drupal\Component\ClassFinder\ClassFinderInterface
+ */
+ protected $finder;
+
+ /**
+ * Prepares the annotation definition.
+ *
+ * This is modified from the prepareAnnotationDefinition method from annotated
+ * class discovery to account for multiple providers.
+ *
+ * @param \Drupal\Component\Annotation\AnnotationInterface $annotation
+ * The annotation derived from the plugin.
+ * @param class-string $class
+ * The class used for the plugin.
+ * @param \Drupal\Component\Annotation\Doctrine\StaticReflectionParser|null $parser
+ * Static reflection parser.
+ *
+ * @see \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery::prepareAnnotationDefinition()
+ * @see \Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery::prepareAnnotationDefinition()
+ */
+ protected function prepareAnnotationDefinition(AnnotationInterface $annotation, $class, ?BaseStaticReflectionParser $parser = NULL): void {
+ if (!($annotation instanceof MultipleProviderAnnotationInterface)) {
+ throw new \LogicException('AnnotatedClassDiscoveryAutomatedProviders annotations must implement ' . MultipleProviderAnnotationInterface::class);
+ }
+ if (!$parser) {
+ throw new \LogicException('Parser argument must be passed for automated providers discovery.');
+ }
+ if (!method_exists($this, 'getProviderFromNamespace')) {
+ throw new \LogicException('Classes using \Drupal\migrate\Plugin\Discovery\AnnotatedDiscoveryAutomatedProvidersTrait must have getProviderFromNamespace() method.');
+ }
+ // @see \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery::prepareAnnotationDefinition()
+ $annotation->setClass($class);
+ $providers = $annotation->getProviders();
+ // Loop through all the parent classes and add their providers (which we
+ // infer by parsing their namespaces) to the $providers array.
+ do {
+ $providers[] = $this->getProviderFromNamespace($parser->getNamespaceName());
+ } while ($parser = StaticReflectionParser::getParentParser($parser, $this->finder));
+ $providers = array_diff(array_unique(array_filter($providers)), ['component']);
+ $annotation->setProviders($providers);
+ }
+
+}
diff --git a/core/modules/migrate/src/Plugin/Discovery/AttributeClassDiscoveryAutomatedProviders.php b/core/modules/migrate/src/Plugin/Discovery/AttributeClassDiscoveryAutomatedProviders.php
new file mode 100644
index 000000000000..c5691a57bf9e
--- /dev/null
+++ b/core/modules/migrate/src/Plugin/Discovery/AttributeClassDiscoveryAutomatedProviders.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Plugin\Discovery;
+
+use Drupal\Component\Plugin\Attribute\AttributeInterface;
+use Drupal\Core\Plugin\Discovery\AttributeClassDiscovery;
+use Drupal\migrate\Attribute\MultipleProviderAttributeInterface;
+
+/**
+ * Determines providers based on the namespaces of a class and its ancestors.
+ *
+ * @internal
+ * This is a temporary solution to the fact that migration source plugins have
+ * more than one provider. This functionality will be moved to core in
+ * https://www.drupal.org/node/2786355.
+ */
+class AttributeClassDiscoveryAutomatedProviders extends AttributeClassDiscovery {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function prepareAttributeDefinition(AttributeInterface $attribute, string $class): void {
+ if (!($attribute instanceof MultipleProviderAttributeInterface)) {
+ throw new \LogicException('AttributeClassDiscoveryAutomatedProviders must implement ' . MultipleProviderAttributeInterface::class);
+ }
+ // @see Drupal\Component\Plugin\Discovery\AttributeClassDiscovery::prepareAttributeDefinition()
+ $attribute->setClass($class);
+
+ // Loop through all the parent classes and add their providers (which we
+ // infer by parsing their namespaces) to the $providers array.
+ $providers = $attribute->getProviders();
+ do {
+ $providers[] = $this->getProviderFromNamespace($class);
+ } while (($class = get_parent_class($class)) !== FALSE);
+
+ $providers = array_diff(array_unique(array_filter($providers)), ['component']);
+ $attribute->setProviders($providers);
+ }
+
+}
diff --git a/core/modules/migrate/src/Plugin/Discovery/AttributeDiscoveryWithAnnotationsAutomatedProviders.php b/core/modules/migrate/src/Plugin/Discovery/AttributeDiscoveryWithAnnotationsAutomatedProviders.php
new file mode 100644
index 000000000000..fab94bf307fe
--- /dev/null
+++ b/core/modules/migrate/src/Plugin/Discovery/AttributeDiscoveryWithAnnotationsAutomatedProviders.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate\Plugin\Discovery;
+
+use Drupal\Component\Annotation\Doctrine\StaticReflectionParser as BaseStaticReflectionParser;
+use Drupal\Component\Annotation\Reflection\MockFileFinder;
+use Drupal\Component\ClassFinder\ClassFinder;
+use Drupal\Component\Plugin\Attribute\AttributeInterface;
+use Drupal\Core\Plugin\Discovery\AttributeDiscoveryWithAnnotations;
+
+/**
+ * Enables both attribute and annotation discovery for plugin definitions.
+ *
+ * @internal
+ * This is a temporary solution to the fact that migration source plugins have
+ * more than one provider. This functionality will be moved to core in
+ * https://www.drupal.org/node/2786355.
+ */
+class AttributeDiscoveryWithAnnotationsAutomatedProviders extends AttributeDiscoveryWithAnnotations {
+
+ use AnnotatedDiscoveryAutomatedProvidersTrait;
+
+ /**
+ * Instance of attribute class discovery with automatic providers.
+ *
+ * Since there isn't multiple inheritance, instantiate the attribute only
+ * discovery for code reuse.
+ *
+ * @var \Drupal\migrate\Plugin\Discovery\AttributeClassDiscoveryAutomatedProviders
+ */
+ private AttributeClassDiscoveryAutomatedProviders $attributeDiscovery;
+
+ public function __construct(
+ string $subdir,
+ \Traversable $rootNamespaces,
+ string $pluginDefinitionAttributeName = 'Drupal\Component\Plugin\Attribute\Plugin',
+ string $pluginDefinitionAnnotationName = 'Drupal\Component\Annotation\Plugin',
+ array $additionalNamespaces = [],
+ ) {
+ parent::__construct($subdir, $rootNamespaces, $pluginDefinitionAttributeName, $pluginDefinitionAnnotationName, $additionalNamespaces);
+ $this->finder = new ClassFinder();
+ $this->attributeDiscovery = new AttributeClassDiscoveryAutomatedProviders($subdir, $rootNamespaces, $pluginDefinitionAttributeName);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function prepareAttributeDefinition(AttributeInterface $attribute, string $class): void {
+ $this->attributeDiscovery->prepareAttributeDefinition($attribute, $class);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function parseClass(string $class, \SplFileInfo $fileinfo): array {
+ // The filename is already known, so there is no need to find the
+ // file. However, StaticReflectionParser needs a finder, so use a
+ // mock version.
+ $finder = MockFileFinder::create($fileinfo->getPathName());
+ $parser = new BaseStaticReflectionParser($class, $finder, FALSE);
+
+ $reflection_class = $parser->getReflectionClass();
+ // @todo Handle deprecating definitions discovery via annotations in
+ // https://www.drupal.org/project/drupal/issues/3265945.
+ /** @var \Drupal\Component\Annotation\AnnotationInterface $annotation */
+ if ($annotation = $this->getAnnotationReader()->getClassAnnotation($reflection_class, $this->pluginDefinitionAnnotationName)) {
+ $this->prepareAnnotationDefinition($annotation, $class, $parser);
+ return ['id' => $annotation->getId(), 'content' => $annotation->get()];
+ }
+
+ // Annotations use static reflection and are able to analyze a class that
+ // extends classes or uses traits that do not exist. Attribute discovery
+ // will trigger a fatal error with such classes, so only call it if the
+ // class has a class attribute.
+ if ($reflection_class->hasClassAttribute($this->pluginDefinitionAttributeName)) {
+ return parent::parseClass($class, $fileinfo);
+ }
+ return ['id' => NULL, 'content' => NULL];
+ }
+
+}
diff --git a/core/modules/migrate/src/Plugin/MigrateDestinationInterface.php b/core/modules/migrate/src/Plugin/MigrateDestinationInterface.php
index d2c7fb7ee994..d2dbe2f68abd 100644
--- a/core/modules/migrate/src/Plugin/MigrateDestinationInterface.php
+++ b/core/modules/migrate/src/Plugin/MigrateDestinationInterface.php
@@ -13,7 +13,7 @@
*
* @see \Drupal\migrate\Plugin\migrate\destination\DestinationBase
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
- * @see \Drupal\migrate\Annotation\MigrateDestination
+ * @see \Drupal\migrate\Attribute\MigrateDestination
* @see plugin_api
*
* @ingroup migration
diff --git a/core/modules/migrate/src/Plugin/MigrateDestinationPluginManager.php b/core/modules/migrate/src/Plugin/MigrateDestinationPluginManager.php
index b65515c3afed..6b7514435f29 100644
--- a/core/modules/migrate/src/Plugin/MigrateDestinationPluginManager.php
+++ b/core/modules/migrate/src/Plugin/MigrateDestinationPluginManager.php
@@ -5,13 +5,14 @@
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\migrate\Attribute\MigrateDestination;
/**
* Plugin manager for migrate destination plugins.
*
* @see \Drupal\migrate\Plugin\MigrateDestinationInterface
* @see \Drupal\migrate\Plugin\migrate\destination\DestinationBase
- * @see \Drupal\migrate\Annotation\MigrateDestination
+ * @see \Drupal\migrate\Attribute\MigrateDestination
* @see plugin_api
*
* @ingroup migration
@@ -40,12 +41,15 @@ class MigrateDestinationPluginManager extends MigratePluginManager {
* The module handler to invoke the alter hook with.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
+ * @param string $attribute
+ * (optional) The attribute class name. Defaults to
+ * 'Drupal\migrate\Attribute\MigrateDestination'.
* @param string $annotation
* (optional) The annotation class name. Defaults to
* 'Drupal\migrate\Annotation\MigrateDestination'.
*/
- public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, $annotation = 'Drupal\migrate\Annotation\MigrateDestination') {
- parent::__construct($type, $namespaces, $cache_backend, $module_handler, $annotation);
+ public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, $attribute = MigrateDestination::class, $annotation = 'Drupal\migrate\Annotation\MigrateDestination') {
+ parent::__construct($type, $namespaces, $cache_backend, $module_handler, $attribute, $annotation);
$this->entityTypeManager = $entity_type_manager;
}
diff --git a/core/modules/migrate/src/Plugin/MigratePluginManager.php b/core/modules/migrate/src/Plugin/MigratePluginManager.php
index b3645dbdd0e4..9eba756ab1be 100644
--- a/core/modules/migrate/src/Plugin/MigratePluginManager.php
+++ b/core/modules/migrate/src/Plugin/MigratePluginManager.php
@@ -2,6 +2,8 @@
namespace Drupal\migrate\Plugin;
+use Drupal\Component\Plugin\Attribute\AttributeInterface;
+use Drupal\Component\Plugin\Attribute\PluginID;
use Drupal\Component\Plugin\Factory\DefaultFactory;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
@@ -11,10 +13,10 @@
* Manages migrate plugins.
*
* @see hook_migrate_info_alter()
- * @see \Drupal\migrate\Annotation\MigrateSource
+ * @see \Drupal\migrate\Attribute\MigrateSource
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- * @see \Drupal\migrate\Annotation\MigrateProcessPlugin
+ * @see \Drupal\migrate\Attribute\MigrateProcess
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
* @see \Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
* @see plugin_api
@@ -36,12 +38,20 @@ class MigratePluginManager extends DefaultPluginManager implements MigratePlugin
* Cache backend instance to use.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to invoke the alter hook with.
+ * @param string $attribute
+ * (optional) The attribute class name. Defaults to
+ * 'Drupal\Component\Plugin\Attribute\PluginID'.
* @param string $annotation
* (optional) The annotation class name. Defaults to
* 'Drupal\Component\Annotation\PluginID'.
*/
- public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, $annotation = 'Drupal\Component\Annotation\PluginID') {
- parent::__construct("Plugin/migrate/$type", $namespaces, $module_handler, NULL, $annotation);
+ public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, $attribute = PluginID::class, $annotation = 'Drupal\Component\Annotation\PluginID') {
+ if (!is_subclass_of($attribute, AttributeInterface::class)) {
+ // Backward compatibility.
+ $annotation = $attribute;
+ $attribute = PluginID::class;
+ }
+ parent::__construct("Plugin/migrate/$type", $namespaces, $module_handler, NULL, $attribute, $annotation);
$this->alterInfo('migrate_' . $type . '_info');
$this->setCacheBackend($cache_backend, 'migrate_plugins_' . $type);
}
diff --git a/core/modules/migrate/src/Plugin/MigrateProcessInterface.php b/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
index 6b3832c89b6f..7d2d365d8817 100644
--- a/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
+++ b/core/modules/migrate/src/Plugin/MigrateProcessInterface.php
@@ -15,7 +15,7 @@
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\ProcessPluginBase
- * @see \Drupal\migrate\Annotation\MigrateProcessPlugin
+ * @see \Drupal\migrate\Attribute\MigrateProcess
* @see plugin_api
*
* @ingroup migration
diff --git a/core/modules/migrate/src/Plugin/MigrateSourceInterface.php b/core/modules/migrate/src/Plugin/MigrateSourceInterface.php
index f33dc68cbc80..b05236ad369a 100644
--- a/core/modules/migrate/src/Plugin/MigrateSourceInterface.php
+++ b/core/modules/migrate/src/Plugin/MigrateSourceInterface.php
@@ -9,7 +9,7 @@
* Defines an interface for migrate sources.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
- * @see \Drupal\migrate\Annotation\MigrateSource
+ * @see \Drupal\migrate\Attribute\MigrateSource
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
* @see plugin_api
*
diff --git a/core/modules/migrate/src/Plugin/MigrateSourcePluginManager.php b/core/modules/migrate/src/Plugin/MigrateSourcePluginManager.php
index 965da5dd766e..74fb59b59447 100644
--- a/core/modules/migrate/src/Plugin/MigrateSourcePluginManager.php
+++ b/core/modules/migrate/src/Plugin/MigrateSourcePluginManager.php
@@ -4,8 +4,10 @@
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
-use Drupal\migrate\Plugin\Discovery\AnnotatedClassDiscoveryAutomatedProviders;
use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator;
+use Drupal\migrate\Plugin\Discovery\AnnotatedClassDiscoveryAutomatedProviders;
+use Drupal\migrate\Plugin\Discovery\AttributeClassDiscoveryAutomatedProviders;
+use Drupal\migrate\Plugin\Discovery\AttributeDiscoveryWithAnnotationsAutomatedProviders;
use Drupal\migrate\Plugin\Discovery\ProviderFilterDecorator;
/**
@@ -13,7 +15,7 @@
*
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- * @see \Drupal\migrate\Annotation\MigrateSource
+ * @see \Drupal\migrate\Attribute\MigrateSource
* @see plugin_api
*
* @ingroup migration
@@ -35,7 +37,7 @@ class MigrateSourcePluginManager extends MigratePluginManager {
* The module handler to invoke the alter hook with.
*/
public function __construct($type, \Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
- parent::__construct($type, $namespaces, $cache_backend, $module_handler, 'Drupal\migrate\Annotation\MigrateSource');
+ parent::__construct($type, $namespaces, $cache_backend, $module_handler, 'Drupal\migrate\Attribute\MigrateSource', 'Drupal\migrate\Annotation\MigrateSource');
}
/**
@@ -43,7 +45,30 @@ public function __construct($type, \Traversable $namespaces, CacheBackendInterfa
*/
protected function getDiscovery() {
if (!$this->discovery) {
- $discovery = new AnnotatedClassDiscoveryAutomatedProviders($this->subdir, $this->namespaces, $this->pluginDefinitionAnnotationName, $this->additionalAnnotationNamespaces);
+ if (isset($this->pluginDefinitionAttributeName) && isset($this->pluginDefinitionAnnotationName)) {
+ $discovery = new AttributeDiscoveryWithAnnotationsAutomatedProviders(
+ $this->subdir,
+ $this->namespaces,
+ $this->pluginDefinitionAttributeName,
+ $this->pluginDefinitionAnnotationName,
+ $this->additionalAnnotationNamespaces,
+ );
+ }
+ elseif (isset($this->pluginDefinitionAttributeName)) {
+ $discovery = new AttributeClassDiscoveryAutomatedProviders(
+ $this->subdir,
+ $this->namespaces,
+ $this->pluginDefinitionAttributeName,
+ );
+ }
+ else {
+ $discovery = new AnnotatedClassDiscoveryAutomatedProviders(
+ $this->subdir,
+ $this->namespaces,
+ $this->pluginDefinitionAnnotationName,
+ $this->additionalAnnotationNamespaces,
+ );
+ }
$this->discovery = new ContainerDerivativeDiscoveryDecorator($discovery);
}
return $this->discovery;
diff --git a/core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php b/core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php
index 4a7fc59d8270..5712613e218b 100644
--- a/core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php
+++ b/core/modules/migrate/src/Plugin/migrate/destination/DestinationBase.php
@@ -21,7 +21,7 @@
* information, refer to \Drupal\migrate\Plugin\MigrateDestinationInterface.
*
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
- * @see \Drupal\migrate\Annotation\MigrateDestination
+ * @see \Drupal\migrate\Attribute\MigrateDestination
* @see plugin_api
*
* @ingroup migration
diff --git a/core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php b/core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php
index 80c5da68a5a1..a6b2e3339e52 100644
--- a/core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php
+++ b/core/modules/migrate/src/Plugin/migrate/id_map/NullIdMap.php
@@ -2,6 +2,7 @@
namespace Drupal\migrate\Plugin\migrate\id_map;
+use Drupal\Component\Plugin\Attribute\PluginID;
use Drupal\Core\Plugin\PluginBase;
use Drupal\migrate\MigrateMessageInterface;
use Drupal\migrate\Plugin\MigrateIdMapInterface;
@@ -12,9 +13,8 @@
* Defines the null ID map implementation.
*
* This serves as a dummy in order to not store anything.
- *
- * @PluginID("null")
*/
+#[PluginID('null')]
class NullIdMap extends PluginBase implements MigrateIdMapInterface {
/**
diff --git a/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php b/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php
index b9261d098943..d66d3ce2fb2b 100644
--- a/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php
+++ b/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php
@@ -2,6 +2,7 @@
namespace Drupal\migrate\Plugin\migrate\id_map;
+use Drupal\Component\Plugin\Attribute\PluginID;
use Drupal\Core\Database\DatabaseException;
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\Exception\SchemaTableKeyTooLargeException;
@@ -30,9 +31,8 @@
*
* It creates one map and one message table per migration entity to store the
* relevant information.
- *
- * @PluginID("sql")
*/
+#[PluginID('sql')]
class Sql extends PluginBase implements MigrateIdMapInterface, ContainerFactoryPluginInterface, HighestIdInterface {
/**
diff --git a/core/modules/migrate/src/Plugin/migrate/process/Explode.php b/core/modules/migrate/src/Plugin/migrate/process/Explode.php
index 38a58ed4a405..c6d902492659 100644
--- a/core/modules/migrate/src/Plugin/migrate/process/Explode.php
+++ b/core/modules/migrate/src/Plugin/migrate/process/Explode.php
@@ -2,6 +2,7 @@
namespace Drupal\migrate\Plugin\migrate\process;
+use Drupal\migrate\Attribute\MigrateProcess;
use Drupal\migrate\ProcessPluginBase;
use Drupal\migrate\MigrateException;
use Drupal\migrate\MigrateExecutableInterface;
@@ -86,11 +87,8 @@
* configuration, if foo is '', NULL or FALSE, then bar will be [].
*
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
- *
- * @MigrateProcessPlugin(
- * id = "explode"
- * )
*/
+#[MigrateProcess('explode')]
class Explode extends ProcessPluginBase {
/**
diff --git a/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php b/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php
index a61a951f3e05..251df66accba 100644
--- a/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php
+++ b/core/modules/migrate/src/Plugin/migrate/source/EmbeddedDataSource.php
@@ -2,6 +2,7 @@
namespace Drupal\migrate\Plugin\migrate\source;
+use Drupal\migrate\Attribute\MigrateSource;
use Drupal\migrate\Plugin\MigrationInterface;
/**
@@ -40,12 +41,11 @@
*
* For additional configuration keys, refer to the parent class:
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- *
- * @MigrateSource(
- * id = "embedded_data",
- * source_module = "migrate"
- * )
*/
+#[MigrateSource(
+ id: 'embedded_data',
+ source_module: 'migrate'
+)]
class EmbeddedDataSource extends SourcePluginBase {
/**
diff --git a/core/modules/migrate/src/Plugin/migrate/source/EmptySource.php b/core/modules/migrate/src/Plugin/migrate/source/EmptySource.php
index 2991aeec7a26..ee56876cdc0b 100644
--- a/core/modules/migrate/src/Plugin/migrate/source/EmptySource.php
+++ b/core/modules/migrate/src/Plugin/migrate/source/EmptySource.php
@@ -2,6 +2,8 @@
namespace Drupal\migrate\Plugin\migrate\source;
+use Drupal\migrate\Attribute\MigrateSource;
+
/**
* Source returning a row based on the constants provided.
*
@@ -21,12 +23,11 @@
*
* For additional configuration keys, refer to the parent class:
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- *
- * @MigrateSource(
- * id = "empty",
- * source_module = "migrate"
- * )
*/
+#[MigrateSource(
+ id: 'empty',
+ source_module: 'migrate',
+)]
class EmptySource extends SourcePluginBase {
/**
diff --git a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php
index e6d5d786dd7f..e98d41975d03 100644
--- a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php
+++ b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php
@@ -105,7 +105,7 @@
* In this example, the constant 'foo' is defined with a value of 'bar'. It is
* later used in the process pipeline to set the value of the field baz.
*
- * @see \Drupal\migrate\Annotation\MigrateSource
+ * @see \Drupal\migrate\Attribute\MigrateSource
* @see \Drupal\migrate\Plugin\MigrateIdMapInterface
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
diff --git a/core/modules/migrate/src/ProcessPluginBase.php b/core/modules/migrate/src/ProcessPluginBase.php
index 5c6978ec335d..e7b1fcc83126 100644
--- a/core/modules/migrate/src/ProcessPluginBase.php
+++ b/core/modules/migrate/src/ProcessPluginBase.php
@@ -21,7 +21,7 @@
* @see https://www.drupal.org/node/2129651
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
- * @see \Drupal\migrate\Annotation\MigrateProcessPlugin
+ * @see \Drupal\migrate\Attribute\MigrateProcess
* @see \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty
* @see d7_field_formatter_settings.yml
* @see plugin_api
diff --git a/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/migrate_source_annotation_bc_test.info.yml b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/migrate_source_annotation_bc_test.info.yml
new file mode 100644
index 000000000000..a87b6c047ad2
--- /dev/null
+++ b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/migrate_source_annotation_bc_test.info.yml
@@ -0,0 +1,5 @@
+name: 'Migrate module source annotation bc tests'
+type: module
+description: 'Support module for source plugin annotation discovery backwards compatibility tests'
+package: Testing
+version: VERSION
diff --git a/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotations.php b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotations.php
new file mode 100644
index 000000000000..145adcaa59a8
--- /dev/null
+++ b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotations.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Drupal\migrate_source_annotation_bc_test\Plugin\migrate\source;
+
+use Drupal\migrate\Plugin\migrate\source\SourcePluginBase;
+
+/**
+ * A migration source plugin with annotations and a single provider.
+ *
+ * This plugin exists to test backwards compatibility of source plugin discovery
+ * for plugin classes using annotations. This class has no providers other than
+ * 'migrate_source_annotation_bc_test' and 'core'. This class and its annotation
+ * should remain until annotation support is completely removed.
+ *
+ * @MigrateSource(
+ * id = "annotated",
+ * source_module = "migrate"
+ * )
+ */
+class MigrateSourceWithAnnotations extends SourcePluginBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function fields() {
+ return [];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __toString() {
+ return 'Annotated';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getIds() {
+ return [];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function initializeIterator() {
+ return new \ArrayIterator();
+ }
+
+}
diff --git a/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotationsMultipleProviders.php b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotationsMultipleProviders.php
new file mode 100644
index 000000000000..dabc2c3d70cc
--- /dev/null
+++ b/core/modules/migrate/tests/modules/migrate_source_annotation_bc_test/src/Plugin/migrate/source/MigrateSourceWithAnnotationsMultipleProviders.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Drupal\migrate_source_annotation_bc_test\Plugin\migrate\source;
+
+use Drupal\migrate_drupal\Plugin\migrate\source\EmptySource;
+
+/**
+ * A migration source plugin with annotations and multiple providers.
+ *
+ * This plugin exists to test backwards compatibility of source plugin discovery
+ * for plugin classes using annotations. This class has an additional provider,
+ * because it extends a plugin in migrate_drupal. This class and its annotation
+ * should remain until annotation support is completely removed.
+ *
+ * @MigrateSource(
+ * id = "annotated_multiple_providers",
+ * source_module = "migrate"
+ * )
+ */
+class MigrateSourceWithAnnotationsMultipleProviders extends EmptySource {
+
+ /**
+ * {@inheritdoc}
+ */
+ public function __toString() {
+ return 'Annotated multiple providers';
+ }
+
+}
diff --git a/core/modules/migrate/tests/src/Kernel/Plugin/source/MigrateSourceAnnotationDiscoveryTest.php b/core/modules/migrate/tests/src/Kernel/Plugin/source/MigrateSourceAnnotationDiscoveryTest.php
new file mode 100644
index 000000000000..324a79706017
--- /dev/null
+++ b/core/modules/migrate/tests/src/Kernel/Plugin/source/MigrateSourceAnnotationDiscoveryTest.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Drupal\Tests\migrate\Kernel\Plugin\source;
+
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests discovery of source plugins with annotations.
+ *
+ * Migrate source plugins use a specific discovery class to accommodate multiple
+ * providers. This is a backwards compatibility test that discovery for plugin
+ * classes that have annotations still works even after all core plugins have
+ * been converted to attributes.
+ *
+ * @group migrate
+ */
+class MigrateSourceAnnotationDiscoveryTest extends KernelTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected static $modules = ['migrate'];
+
+ /**
+ * @covers \Drupal\migrate\Plugin\MigrateSourcePluginManager::getDefinitions
+ */
+ public function testGetDefinitions(): void {
+ // First, test attribute-only discovery.
+ $expected = ['embedded_data', 'empty'];
+ $source_plugins = $this->container->get('plugin.manager.migrate.source')->getDefinitions();
+ ksort($source_plugins);
+ $this->assertSame($expected, array_keys($source_plugins));
+
+ // Next, test discovery of both attributed and annotated plugins. The
+ // annotated plugin with multiple providers depends on migrate_drupal and
+ // should not be discovered with it uninstalled.
+ $expected = ['annotated', 'embedded_data', 'empty'];
+ $this->enableModules(['migrate_source_annotation_bc_test']);
+ $source_plugins = $this->container->get('plugin.manager.migrate.source')->getDefinitions();
+ ksort($source_plugins);
+ $this->assertSame($expected, array_keys($source_plugins));
+
+ // Install migrate_drupal and now the annotated plugin that depends on it
+ // should be discovered.
+ $expected = [
+ 'annotated',
+ 'annotated_multiple_providers',
+ 'embedded_data',
+ 'empty',
+ ];
+ $this->enableModules(['migrate_drupal']);
+ $source_plugins = $this->container->get('plugin.manager.migrate.source')->getDefinitions();
+ // Confirming here the that the source plugins that migrate and
+ // migrate_source_annotation_bc_test are discovered. There are additional
+ // plugins provided by migrate_drupal, but they do not need to be enumerated
+ // here.
+ $this->assertSame(array_diff($expected, array_keys($source_plugins)), []);
+ }
+
+}
diff --git a/core/modules/migrate_drupal/migrate_drupal.services.yml b/core/modules/migrate_drupal/migrate_drupal.services.yml
index 80444d04750b..9e3662341b98 100644
--- a/core/modules/migrate_drupal/migrate_drupal.services.yml
+++ b/core/modules/migrate_drupal/migrate_drupal.services.yml
@@ -6,6 +6,7 @@ services:
- '@container.namespaces'
- '@cache.discovery'
- '@module_handler'
+ - '\Drupal\migrate_drupal\Attribute\MigrateField'
- '\Drupal\migrate_drupal\Annotation\MigrateField'
Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface: '@plugin.manager.migrate.field'
logger.channel.migrate_drupal:
diff --git a/core/modules/migrate_drupal/src/Attribute/MigrateField.php b/core/modules/migrate_drupal/src/Attribute/MigrateField.php
new file mode 100644
index 000000000000..ffb529e98000
--- /dev/null
+++ b/core/modules/migrate_drupal/src/Attribute/MigrateField.php
@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\migrate_drupal\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+
+/**
+ * Defines a field plugin attribute object.
+ *
+ * Field plugins are responsible for handling the migration of custom fields
+ * (provided by Field API in Drupal 7) to Drupal 8+. They are allowed to alter
+ * fieldable entity migrations when these migrations are being generated, and
+ * can compute destination field types for individual fields during the actual
+ * migration process.
+ *
+ * Plugin Namespace: Plugin\migrate\field
+ *
+ * For a working example, see
+ * \Drupal\datetime\Plugin\migrate\field\DateField
+ *
+ * @see \Drupal\migrate\Plugin\MigratePluginManager
+ * @see \Drupal\migrate_drupal\Plugin\MigrateFieldInterface;
+ * @see \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
+ * @see plugin_api
+ *
+ * @ingroup migration
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class MigrateField extends Plugin {
+
+ /**
+ * The plugin definition.
+ *
+ * @var array
+ */
+ protected $definition;
+
+ /**
+ * Constructs a migrate field attribute object.
+ *
+ * @param string $id
+ * A unique identifier for the field plugin.
+ * @param int[] $core
+ * (optional) The Drupal core version(s) this plugin applies to.
+ * @param int $weight
+ * (optional) The weight of this plugin relative to other plugins servicing
+ * the same field type and core version. The lowest weighted applicable
+ * plugin will be used for each field.
+ * @param string[] $type_map
+ * (optional) Map of D6 and D7 field types to D8+ field type plugin IDs.
+ * @param string|null $source_module
+ * (optional) Identifies the system providing the data the field plugin will
+ * read. The source_module is expected to be the name of a Drupal module
+ * that must be installed in the source database.
+ * @param string|null $destination_module
+ * (optional) Identifies the system handling the data the destination plugin
+ * will write. The destination_module is expected to be the name of a Drupal
+ * module on the destination site that must be installed.
+ * @param class-string|null $deriver
+ * (optional) The deriver class.
+ */
+ public function __construct(
+ public readonly string $id,
+ public readonly array $core = [6],
+ public readonly int $weight = 0,
+ public readonly array $type_map = [],
+ public readonly ?string $source_module = NULL,
+ public readonly ?string $destination_module = NULL,
+ public readonly ?string $deriver = NULL
+ ) {}
+
+}
diff --git a/core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManager.php b/core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManager.php
index 5859ff3aa7dc..cce492cfc34c 100644
--- a/core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManager.php
+++ b/core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManager.php
@@ -11,7 +11,7 @@
* Plugin manager for migrate field plugins.
*
* @see \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- * @see \Drupal\migrate\Annotation\MigrateField
+ * @see \Drupal\migrate\Attribute\MigrateField
* @see plugin_api
*
* @ingroup migration
@@ -48,7 +48,7 @@ class MigrateFieldPluginManager extends MigratePluginManager implements MigrateF
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* If the plugin cannot be determined, such as if the field type is invalid.
*
- * @see \Drupal\migrate_drupal\Annotation\MigrateField
+ * @see \Drupal\migrate_drupal\Attribute\MigrateField
*/
public function getPluginIdFromFieldType($field_type, array $configuration = [], MigrationInterface $migration = NULL) {
$core = static::DEFAULT_CORE_VERSION;
diff --git a/core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php b/core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php
index b62ac0f994cc..36a25211ece9 100644
--- a/core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php
+++ b/core/modules/migrate_drupal/src/Plugin/migrate/field/FieldPluginBase.php
@@ -11,7 +11,7 @@
* The base class for all field plugins.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
- * @see \Drupal\migrate_drupal\Annotation\MigrateField
+ * @see \Drupal\migrate_drupal\Attribute\MigrateField
* @see \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
* @see plugin_api
*
diff --git a/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php b/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php
index 5d80f6160a77..bc7ff421ff7a 100644
--- a/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php
+++ b/core/modules/migrate_drupal/src/Plugin/migrate/source/ContentEntity.php
@@ -9,6 +9,7 @@
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\migrate\Attribute\MigrateSource;
use Drupal\migrate\EntityFieldDefinitionTrait;
use Drupal\migrate\Plugin\migrate\source\SourcePluginBase;
use Drupal\migrate\Plugin\MigrateSourceInterface;
@@ -61,13 +62,12 @@
*
* For additional configuration keys, refer to the parent class:
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- *
- * @MigrateSource(
- * id = "content_entity",
- * source_module = "migrate_drupal",
- * deriver = "\Drupal\migrate_drupal\Plugin\migrate\source\ContentEntityDeriver",
- * )
- */
+ */
+#[MigrateSource(
+ id: "content_entity",
+ source_module: "migrate_drupal",
+ deriver: ContentEntityDeriver::class,
+)]
class ContentEntity extends SourcePluginBase implements ContainerFactoryPluginInterface {
use EntityFieldDefinitionTrait;
--
GitLab