Issue #3420987 by kim.pepper, smustgrave: Convert DataType plugin discovery to attributes

core/lib/Drupal/Core/Entity/Plugin/DataType/EntityAdapter.php

@@ -4,7 +4,10 @@
 
 use Drupal\Core\Entity\FieldableEntityInterface;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver;
 use Drupal\Core\Entity\TypedData\EntityDataDefinition;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\ComplexDataInterface;
 use Drupal\Core\TypedData\Exception\MissingDataException;
 use Drupal\Core\TypedData\TypedData;
@@ -17,15 +20,14 @@
  *
  * In addition to the "entity" data type, this exposes derived
  * "entity:$entity_type" and "entity:$entity_type:$bundle" data types.
- *
- * @DataType(
- *   id = "entity",
- *   label = @Translation("Entity"),
- *   description = @Translation("All kind of entities, e.g. nodes, comments or users."),
- *   deriver = "\Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver",
- *   definition_class = "\Drupal\Core\Entity\TypedData\EntityDataDefinition"
- * )
  */
+#[DataType(
+  id: "entity",
+  label: new TranslatableMarkup("Entity"),
+  description: new TranslatableMarkup("All kind of entities, e.g. nodes, comments or users."),
+  definition_class: EntityDataDefinition::class,
+  deriver: EntityDeriver::class
+)]
 class EntityAdapter extends TypedData implements \IteratorAggregate, ComplexDataInterface {
 
   /**

core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php

@@ -3,7 +3,10 @@
 namespace Drupal\Core\Entity\Plugin\DataType;
 
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\DataReferenceBase;
+use Drupal\Core\TypedData\DataReferenceDefinition;
 
 /**
  * Defines an 'entity_reference' data type.
@@ -24,13 +27,12 @@
  * \Drupal\Core\TypedData\DataReferenceDefinition::create('entity')
  *   ->setTargetDefinition($definition);
  * @endcode
- *
- * @DataType(
- *   id = "entity_reference",
- *   label = @Translation("Entity reference"),
- *   definition_class = "\Drupal\Core\TypedData\DataReferenceDefinition"
- * )
  */
+#[DataType(
+  id: "entity_reference",
+  label: new TranslatableMarkup("Entity reference"),
+  definition_class: DataReferenceDefinition::class,
+)]
 class EntityReference extends DataReferenceBase {
 
   /**

core/lib/Drupal/Core/Field/Plugin/DataType/FieldItem.php

@@ -2,19 +2,23 @@
 
 namespace Drupal\Core\Field\Plugin\DataType;
 
+use Drupal\Core\Field\FieldItemList;
+use Drupal\Core\Field\Plugin\DataType\Deriver\FieldItemDeriver;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
+
 /**
  * Defines the base plugin for deriving data types for field types.
  *
  * Note that the class only register the plugin, and is actually never used.
  * \Drupal\Core\Field\FieldItemBase is available for use as base class.
- *
- * @DataType(
- *   id = "field_item",
- *   label = @Translation("Field item"),
- *   list_class = "\Drupal\Core\Field\FieldItemList",
- *   deriver = "Drupal\Core\Field\Plugin\DataType\Deriver\FieldItemDeriver"
- * )
  */
+#[DataType(
+  id: "field_item",
+  label: new TranslatableMarkup("Field item"),
+  list_class: FieldItemList::class,
+  deriver: FieldItemDeriver::class
+)]
 abstract class FieldItem {
 
 }

core/lib/Drupal/Core/TypedData/Attribute/DataType.php

+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Core\TypedData\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\DataDefinition;
+use Drupal\Core\TypedData\ListDataDefinition;
+use Drupal\Core\TypedData\Plugin\DataType\ItemList;
+
+/**
+ * Defines a data type attribute.
+ *
+ * The typed data API allows modules to support any kind of data based upon
+ * pre-defined primitive types and interfaces for complex data and lists.
+ *
+ * Defined data types may map to one of the pre-defined primitive types below
+ * \Drupal\Core\TypedData\Type or may be complex data types, containing
+ * one or more data properties. Typed data objects for complex data types have
+ * to implement the \Drupal\Core\TypedData\ComplexDataInterface. Further
+ * interfaces that may be implemented are:
+ *  - \Drupal\Core\Access\AccessibleInterface
+ *  - \Drupal\Core\TypedData\TranslatableInterface
+ *
+ * Furthermore, lists of data items are represented by objects implementing the
+ * \Drupal\Core\TypedData\ListInterface. A list contains items of the same data
+ * type, is ordered and may contain duplicates. The class used for a list of
+ * items of a certain type may be specified using the 'list class' key.
+ *
+ * @see \Drupal::typedDataManager()
+ * @see \Drupal\Core\TypedData\TypedDataManager::create()
+ * @see hook_data_type_info_alter()
+ *
+ * @ingroup typed_data
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class DataType extends Plugin {
+
+  /**
+   * Constructs a new DataType attribute.
+   *
+   * @param string $id
+   *   The data type plugin ID.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $label
+   *   The human-readable name of the data type.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
+   *   (optional) The description of the data type.
+   * @param string|null $definition_class
+   *   (optional) The definition class to use for defining data of this type.
+   * @param string|null $list_class
+   *   (optional) The typed data class used for wrapping multiple data items of
+   *   the type.
+   * @param string|null $list_definition_class
+   *   (optional) The definition class to use for defining a list of items of
+   *   this type.
+   * @param array $constraints
+   *   (optional) An array of validation constraints for this type.
+   * @param bool $unwrap_for_canonical_representation
+   *   Whether the typed object wraps the canonical representation of the data.
+   * @param string|null $deriver
+   *   (optional) The deriver class for the data type.
+   *
+   * @see \Drupal\Core\TypedData\TypedDataManager::getConstraints()
+   * @see \Drupal\Core\TypedData\TypedDataManager::getCanonicalRepresentation()
+   */
+  public function __construct(
+    public readonly string $id,
+    public readonly TranslatableMarkup $label,
+    public readonly ?TranslatableMarkup $description = NULL,
+    public readonly ?string $definition_class = DataDefinition::class,
+    public readonly ?string $list_class = ItemList::class,
+    public readonly ?string $list_definition_class = ListDataDefinition::class,
+    public readonly array $constraints = [],
+    public readonly bool $unwrap_for_canonical_representation = TRUE,
+    public readonly ?string $deriver = NULL,
+  ) {}
+
+}

core/lib/Drupal/Core/TypedData/Plugin/DataType/Any.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\TypedData;
 
 /**
@@ -10,12 +12,11 @@
  * The "any" data type does not implement a list or complex data interface, nor
  * is it mappable to any primitive type. Thus, it may contain any PHP data for
  * which no further metadata is available.
- *
- * @DataType(
- *   id = "any",
- *   label = @Translation("Any data")
- * )
  */
+#[DataType(
+  id: "any",
+  label: new TranslatableMarkup("Any data")
+)]
 class Any extends TypedData {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\PrimitiveBase;
 use Drupal\Core\TypedData\Type\BinaryInterface;
 
@@ -11,12 +13,11 @@
  * The plain value of binary data is a PHP file resource, see
  * http://php.net/manual/language.types.resource.php. For setting the value
  * a PHP file resource or an (absolute) stream resource URI may be passed.
- *
- * @DataType(
- *   id = "binary",
- *   label = @Translation("Binary")
- * )
  */
+#[DataType(
+  id: "binary",
+  label: new TranslatableMarkup("Binary")
+)]
 class BinaryData extends PrimitiveBase implements BinaryInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/BooleanData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\PrimitiveBase;
 use Drupal\Core\TypedData\Type\BooleanInterface;
 
@@ -10,12 +12,11 @@
  *
  * The plain value of a boolean is a regular PHP boolean. For setting the value
  * any PHP variable that casts to a boolean may be passed.
- *
- * @DataType(
- *   id = "boolean",
- *   label = @Translation("Boolean")
- * )
  */
+#[DataType(
+  id: "boolean",
+  label: new TranslatableMarkup("Boolean")
+)]
 class BooleanData extends PrimitiveBase implements BooleanInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/DateTimeIso8601.php

@@ -3,18 +3,19 @@
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
 use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\DateTimeInterface;
 
 /**
  * A data type for ISO 8601 date strings.
  *
  * The plain value of this data type is a date string in ISO 8601 format.
- *
- * @DataType(
- *   id = "datetime_iso8601",
- *   label = @Translation("Date")
- * )
  */
+#[DataType(
+  id: "datetime_iso8601",
+  label: new TranslatableMarkup("Date")
+)]
 class DateTimeIso8601 extends StringData implements DateTimeInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/DecimalData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\DecimalInterface;
 
 /**
@@ -10,12 +12,11 @@
  * Decimal type is stored as "decimal" in the relational database. Because PHP
  * does not have a primitive type decimal and using float can result in
  * unexpected rounding behavior, it is implemented and displayed as string.
- *
- * @DataType(
- *   id = "decimal",
- *   label = @Translation("Decimal")
- * )
  */
+#[DataType(
+  id: "decimal",
+  label: new TranslatableMarkup("Decimal"),
+)]
 class DecimalData extends StringData implements DecimalInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php

@@ -2,18 +2,19 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\DurationInterface;
 
 /**
  * The duration ISO8601 data type.
  *
  * The plain value of this data type is an ISO8601 duration string.
- *
- * @DataType(
- *   id = "duration_iso8601",
- *   label = @Translation("Duration")
- * )
  */
+#[DataType(
+  id: "duration_iso8601",
+  label: new TranslatableMarkup("Duration")
+)]
 class DurationIso8601 extends StringData implements DurationInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php

@@ -2,19 +2,20 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\StringInterface;
 
 /**
  * The Email data type.
  *
  * The plain value of Email is the email address represented as PHP string.
- *
- * @DataType(
- *   id = "email",
- *   label = @Translation("Email"),
- *   constraints = {"Email" = {}}
- * )
  */
+#[DataType(
+  id: "email",
+  label: new TranslatableMarkup("Email"),
+  constraints: ["Email" => []],
+)]
 class Email extends StringData implements StringInterface {
 
 }

core/lib/Drupal/Core/TypedData/Plugin/DataType/FloatData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\PrimitiveBase;
 use Drupal\Core\TypedData\Type\FloatInterface;
 
@@ -10,12 +12,11 @@
  *
  * The plain value of a float is a regular PHP float. For setting the value
  * any PHP variable that casts to a float may be passed.
- *
- * @DataType(
- *   id = "float",
- *   label = @Translation("Float")
- * )
  */
+#[DataType(
+  id: "float",
+  label: new TranslatableMarkup("Float")
+)]
 class FloatData extends PrimitiveBase implements FloatInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/IntegerData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\PrimitiveBase;
 use Drupal\Core\TypedData\Type\IntegerInterface;
 
@@ -10,12 +12,11 @@
  *
  * The plain value of an integer is a regular PHP integer. For setting the value
  * any PHP variable that casts to an integer may be passed.
- *
- * @DataType(
- *   id = "integer",
- *   label = @Translation("Integer")
- * )
  */
+#[DataType(
+  id: "integer",
+  label: new TranslatableMarkup("Integer")
+)]
 class IntegerData extends PrimitiveBase implements IntegerInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php

@@ -2,7 +2,10 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\ComplexDataInterface;
+use Drupal\Core\TypedData\ListDataDefinition;
 use Drupal\Core\TypedData\ListInterface;
 use Drupal\Core\TypedData\TypedData;
 use Drupal\Core\TypedData\TypedDataInterface;
@@ -16,13 +19,12 @@
  * Note: The class cannot be called "List" as list is a reserved PHP keyword.
  *
  * @ingroup typed_data
- *
- * @DataType(
- *   id = "list",
- *   label = @Translation("List of items"),
- *   definition_class = "\Drupal\Core\TypedData\ListDataDefinition"
- * )
  */
+#[DataType(
+  id: "list",
+  label: new TranslatableMarkup("List of items"),
+  definition_class: ListDataDefinition::class,
+)]
 class ItemList extends TypedData implements \IteratorAggregate, ListInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\TypedData;
 
 /**
@@ -10,13 +12,12 @@
  * The plain value of a language is the language object, i.e. an instance of
  * \Drupal\Core\Language\Language. For setting the value the language object or
  * the language code as string may be passed.
- *
- * @DataType(
- *   id = "language",
- *   label = @Translation("Language"),
- *   description = @Translation("A language object.")
- * )
  */
+#[DataType(
+  id: "language",
+  label: new TranslatableMarkup("Language"),
+  description: new TranslatableMarkup("A language object.")
+)]
 class Language extends TypedData {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/LanguageReference.php

@@ -3,7 +3,10 @@
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
 use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\DataReferenceBase;
+use Drupal\Core\TypedData\DataReferenceDefinition;
 
 /**
  * Defines the 'language_reference' data type.
@@ -14,13 +17,12 @@
  * The plain value is the language object, i.e. an instance of
  * \Drupal\Core\Language\Language. For setting the value the language object or
  * the language code as string may be passed.
- *
- * @DataType(
- *   id = "language_reference",
- *   label = @Translation("Language reference"),
- *   definition_class = "\Drupal\Core\TypedData\DataReferenceDefinition"
- * )
  */
+#[DataType(
+  id: "language_reference",
+  label: new TranslatableMarkup("Language reference"),
+  definition_class: DataReferenceDefinition::class,
+)]
 class LanguageReference extends DataReferenceBase {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php

@@ -2,8 +2,11 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
-use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\ComplexDataInterface;
+use Drupal\Core\TypedData\MapDataDefinition;
+use Drupal\Core\TypedData\TypedData;
 
 /**
  * The "map" data type.
@@ -17,13 +20,12 @@
  * it.
  *
  * @ingroup typed_data
- *
- * @DataType(
- *   id = "map",
- *   label = @Translation("Map"),
- *   definition_class = "\Drupal\Core\TypedData\MapDataDefinition"
- * )
  */
+#[DataType(
+  id: "map",
+  label: new TranslatableMarkup("Map"),
+  definition_class: MapDataDefinition::class,
+)]
 class Map extends TypedData implements \IteratorAggregate, ComplexDataInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/StringData.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\PrimitiveBase;
 use Drupal\Core\TypedData\Type\StringInterface;
 
@@ -10,12 +12,11 @@
  *
  * The plain value of a string is a regular PHP string. For setting the value
  * any PHP variable that casts to a string may be passed.
- *
- * @DataType(
- *   id = "string",
- *   label = @Translation("String")
- * )
  */
+#[DataType(
+  id: "string",
+  label: new TranslatableMarkup("String")
+)]
 class StringData extends PrimitiveBase implements StringInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/TimeSpan.php

@@ -2,6 +2,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\DurationInterface;
 
 /**
@@ -13,13 +15,12 @@
  * hours due to daylight savings). If that's an issue, consider using
  * \Drupal\Core\TypedData\Type\DurationIso8601 instead.
  *
- * @DataType(
- *   id = "timespan",
- *   label = @Translation("Time span in seconds")
- * )
- *
  * @see \Drupal\Core\TypedData\Type\DurationIso8601
  */
+#[DataType(
+  id: "timespan",
+  label: new TranslatableMarkup("Time span in seconds"),
+)]
 class TimeSpan extends IntegerData implements DurationInterface {
 
   /**

core/lib/Drupal/Core/TypedData/Plugin/DataType/Timestamp.php

@@ -3,16 +3,17 @@
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
 use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\Core\TypedData\Attribute\DataType;
 use Drupal\Core\TypedData\Type\DateTimeInterface;
 
 /**
  * The timestamp data type.
- *
- * @DataType(
- *   id = "timestamp",
- *   label = @Translation("Timestamp")
- * )
  */
+#[DataType(
+  id: "timestamp",
+  label: new TranslatableMarkup("Timestamp"),
+)]
 class Timestamp extends IntegerData implements DateTimeInterface {
 
   /**