Deprecate the Annotation interface (doctrine#10178)

derrabus · Oct 26, 2022 · 543be3f · 543be3f
1 parent 1edfa91
commit 543be3f
Show file tree

Hide file tree

Showing 56 changed files with 72 additions and 52 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -18,6 +18,10 @@ As a consequence, the following methods are deprecated:
 - `ORMSetup::createAnnotationMetadataConfiguration`
 - `ORMSetup::createDefaultAnnotationDriver`
 
+The marker interface `Doctrine\ORM\Mapping\Annotation` is deprecated as well.
+All annotation/attribute classes implement
+`Doctrine\ORM\Mapping\MappingAttribute` now.
+
 ## Deprecated `Doctrine\ORM\Proxy\Proxy` interface.
 
 Use `Doctrine\Persistence\Proxy` instead to check whether proxies are initialized.

diff --git a/lib/Doctrine/ORM/Mapping/Annotation.php b/lib/Doctrine/ORM/Mapping/Annotation.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Mapping;
 
+/** @deprecated Use {@see MappingAttribute} instead. */
 interface Annotation
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/AssociationOverride.php b/lib/Doctrine/ORM/Mapping/AssociationOverride.php
@@ -11,7 +11,7 @@
  * @NamedArgumentConstructor
  * @Target("ANNOTATION")
  */
-final class AssociationOverride implements Annotation
+final class AssociationOverride implements MappingAttribute
 {
     /**
      * The name of the relationship property whose mapping is being overridden.

diff --git a/lib/Doctrine/ORM/Mapping/AssociationOverrides.php b/lib/Doctrine/ORM/Mapping/AssociationOverrides.php
@@ -17,7 +17,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class AssociationOverrides implements Annotation
+final class AssociationOverrides implements MappingAttribute
 {
     /**
      * Mapping overrides of relationship properties.

diff --git a/lib/Doctrine/ORM/Mapping/AttributeOverride.php b/lib/Doctrine/ORM/Mapping/AttributeOverride.php
@@ -11,7 +11,7 @@
  * @NamedArgumentConstructor
  * @Target("ANNOTATION")
  */
-final class AttributeOverride implements Annotation
+final class AttributeOverride implements MappingAttribute
 {
     /**
      * The name of the property whose mapping is being overridden.

diff --git a/lib/Doctrine/ORM/Mapping/AttributeOverrides.php b/lib/Doctrine/ORM/Mapping/AttributeOverrides.php
@@ -17,7 +17,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class AttributeOverrides implements Annotation
+final class AttributeOverrides implements MappingAttribute
 {
     /**
      * One or more field or property mapping overrides.

diff --git a/lib/Doctrine/ORM/Mapping/Cache.php b/lib/Doctrine/ORM/Mapping/Cache.php
@@ -15,7 +15,7 @@
  * @Target({"CLASS","PROPERTY"})
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
-final class Cache implements Annotation
+final class Cache implements MappingAttribute
 {
     /**
      * The concurrency strategy.

diff --git a/lib/Doctrine/ORM/Mapping/ChangeTrackingPolicy.php b/lib/Doctrine/ORM/Mapping/ChangeTrackingPolicy.php
@@ -13,7 +13,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class ChangeTrackingPolicy implements Annotation
+final class ChangeTrackingPolicy implements MappingAttribute
 {
     /**
      * The change tracking policy.

diff --git a/lib/Doctrine/ORM/Mapping/Column.php b/lib/Doctrine/ORM/Mapping/Column.php
@@ -14,7 +14,7 @@
  * @Target({"PROPERTY","ANNOTATION"})
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class Column implements Annotation
+final class Column implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/ColumnResult.php b/lib/Doctrine/ORM/Mapping/ColumnResult.php
@@ -11,7 +11,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class ColumnResult implements Annotation
+final class ColumnResult implements MappingAttribute
 {
     /**
      * The name of a column in the SELECT clause of a SQL query.

diff --git a/lib/Doctrine/ORM/Mapping/CustomIdGenerator.php b/lib/Doctrine/ORM/Mapping/CustomIdGenerator.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class CustomIdGenerator implements Annotation
+final class CustomIdGenerator implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/DiscriminatorColumn.php b/lib/Doctrine/ORM/Mapping/DiscriminatorColumn.php
@@ -13,7 +13,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class DiscriminatorColumn implements Annotation
+final class DiscriminatorColumn implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/DiscriminatorMap.php b/lib/Doctrine/ORM/Mapping/DiscriminatorMap.php
@@ -13,7 +13,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class DiscriminatorMap implements Annotation
+final class DiscriminatorMap implements MappingAttribute
 {
     /**
      * @var array<int|string, string>

diff --git a/lib/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php b/lib/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 require_once __DIR__ . '/../Annotation.php';
+require_once __DIR__ . '/../MappingAttribute.php';
 require_once __DIR__ . '/../Entity.php';
 require_once __DIR__ . '/../Embeddable.php';
 require_once __DIR__ . '/../Embedded.php';

diff --git a/lib/Doctrine/ORM/Mapping/Embeddable.php b/lib/Doctrine/ORM/Mapping/Embeddable.php
@@ -11,6 +11,6 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class Embeddable implements Annotation
+final class Embeddable implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/Embedded.php b/lib/Doctrine/ORM/Mapping/Embedded.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class Embedded implements Annotation
+final class Embedded implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/Entity.php b/lib/Doctrine/ORM/Mapping/Entity.php
@@ -15,7 +15,7 @@
  * @template T of object
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class Entity implements Annotation
+final class Entity implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/EntityListeners.php b/lib/Doctrine/ORM/Mapping/EntityListeners.php
@@ -16,7 +16,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class EntityListeners implements Annotation
+final class EntityListeners implements MappingAttribute
 {
     /**
      * Specifies the names of the entity listeners.

diff --git a/lib/Doctrine/ORM/Mapping/EntityResult.php b/lib/Doctrine/ORM/Mapping/EntityResult.php
@@ -13,7 +13,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class EntityResult implements Annotation
+final class EntityResult implements MappingAttribute
 {
     /**
      * The class of the result.

diff --git a/lib/Doctrine/ORM/Mapping/FieldResult.php b/lib/Doctrine/ORM/Mapping/FieldResult.php
@@ -10,7 +10,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class FieldResult implements Annotation
+final class FieldResult implements MappingAttribute
 {
     /**
      * Name of the column in the SELECT clause.

diff --git a/lib/Doctrine/ORM/Mapping/GeneratedValue.php b/lib/Doctrine/ORM/Mapping/GeneratedValue.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class GeneratedValue implements Annotation
+final class GeneratedValue implements MappingAttribute
 {
     /**
      * The type of ID generator.

diff --git a/lib/Doctrine/ORM/Mapping/HasLifecycleCallbacks.php b/lib/Doctrine/ORM/Mapping/HasLifecycleCallbacks.php
@@ -11,6 +11,6 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class HasLifecycleCallbacks implements Annotation
+final class HasLifecycleCallbacks implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/Id.php b/lib/Doctrine/ORM/Mapping/Id.php
@@ -11,6 +11,6 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class Id implements Annotation
+final class Id implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/Index.php b/lib/Doctrine/ORM/Mapping/Index.php
@@ -13,7 +13,7 @@
  * @Target("ANNOTATION")
  */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-final class Index implements Annotation
+final class Index implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/InheritanceType.php b/lib/Doctrine/ORM/Mapping/InheritanceType.php
@@ -13,7 +13,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class InheritanceType implements Annotation
+final class InheritanceType implements MappingAttribute
 {
     /**
      * The inheritance type used by the class and its subclasses.

diff --git a/lib/Doctrine/ORM/Mapping/InverseJoinColumn.php b/lib/Doctrine/ORM/Mapping/InverseJoinColumn.php
@@ -8,7 +8,7 @@
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class InverseJoinColumn implements Annotation
+final class InverseJoinColumn implements MappingAttribute
 {
     use JoinColumnProperties;
 }
diff --git a/lib/Doctrine/ORM/Mapping/JoinColumn.php b/lib/Doctrine/ORM/Mapping/JoinColumn.php
@@ -13,7 +13,7 @@
  * @Target({"PROPERTY","ANNOTATION"})
  */
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
-final class JoinColumn implements Annotation
+final class JoinColumn implements MappingAttribute
 {
     use JoinColumnProperties;
 }
diff --git a/lib/Doctrine/ORM/Mapping/JoinColumns.php b/lib/Doctrine/ORM/Mapping/JoinColumns.php
@@ -8,7 +8,7 @@
  * @Annotation
  * @Target("PROPERTY")
  */
-final class JoinColumns implements Annotation
+final class JoinColumns implements MappingAttribute
 {
     /** @var array<\Doctrine\ORM\Mapping\JoinColumn> */
     public $value;

diff --git a/lib/Doctrine/ORM/Mapping/JoinTable.php b/lib/Doctrine/ORM/Mapping/JoinTable.php
@@ -13,7 +13,7 @@
  * @Target({"PROPERTY","ANNOTATION"})
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class JoinTable implements Annotation
+final class JoinTable implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/ManyToMany.php b/lib/Doctrine/ORM/Mapping/ManyToMany.php
@@ -14,7 +14,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class ManyToMany implements Annotation
+final class ManyToMany implements MappingAttribute
 {
     /**
      * @var class-string|null

diff --git a/lib/Doctrine/ORM/Mapping/ManyToOne.php b/lib/Doctrine/ORM/Mapping/ManyToOne.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class ManyToOne implements Annotation
+final class ManyToOne implements MappingAttribute
 {
     /**
      * @var class-string|null

diff --git a/lib/Doctrine/ORM/Mapping/MappedSuperclass.php b/lib/Doctrine/ORM/Mapping/MappedSuperclass.php
@@ -14,7 +14,7 @@
  * @Target("CLASS")
  */
 #[Attribute(Attribute::TARGET_CLASS)]
-final class MappedSuperclass implements Annotation
+final class MappedSuperclass implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/MappingAttribute.php b/lib/Doctrine/ORM/Mapping/MappingAttribute.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Mapping;
+
+/** A marker interface for mapping attributes. */
+interface MappingAttribute extends Annotation
+{
+}
diff --git a/lib/Doctrine/ORM/Mapping/NamedNativeQueries.php b/lib/Doctrine/ORM/Mapping/NamedNativeQueries.php
@@ -11,7 +11,7 @@
  * @Annotation
  * @Target("CLASS")
  */
-final class NamedNativeQueries implements Annotation
+final class NamedNativeQueries implements MappingAttribute
 {
     /**
      * One or more NamedNativeQuery annotations.

diff --git a/lib/Doctrine/ORM/Mapping/NamedNativeQuery.php b/lib/Doctrine/ORM/Mapping/NamedNativeQuery.php
@@ -11,7 +11,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class NamedNativeQuery implements Annotation
+final class NamedNativeQuery implements MappingAttribute
 {
     /**
      * The name used to refer to the query with the EntityManager methods that create query objects.

diff --git a/lib/Doctrine/ORM/Mapping/NamedQueries.php b/lib/Doctrine/ORM/Mapping/NamedQueries.php
@@ -8,7 +8,7 @@
  * @Annotation
  * @Target("CLASS")
  */
-final class NamedQueries implements Annotation
+final class NamedQueries implements MappingAttribute
 {
     /** @var array<\Doctrine\ORM\Mapping\NamedQuery> */
     public $value;

diff --git a/lib/Doctrine/ORM/Mapping/NamedQuery.php b/lib/Doctrine/ORM/Mapping/NamedQuery.php
@@ -8,7 +8,7 @@
  * @Annotation
  * @Target("ANNOTATION")
  */
-final class NamedQuery implements Annotation
+final class NamedQuery implements MappingAttribute
 {
     /** @var string */
     public $name;

diff --git a/lib/Doctrine/ORM/Mapping/OneToMany.php b/lib/Doctrine/ORM/Mapping/OneToMany.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class OneToMany implements Annotation
+final class OneToMany implements MappingAttribute
 {
     /**
      * @var string|null

diff --git a/lib/Doctrine/ORM/Mapping/OneToOne.php b/lib/Doctrine/ORM/Mapping/OneToOne.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class OneToOne implements Annotation
+final class OneToOne implements MappingAttribute
 {
     /**
      * @var class-string|null

diff --git a/lib/Doctrine/ORM/Mapping/OrderBy.php b/lib/Doctrine/ORM/Mapping/OrderBy.php
@@ -13,7 +13,7 @@
  * @Target("PROPERTY")
  */
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class OrderBy implements Annotation
+final class OrderBy implements MappingAttribute
 {
     /**
      * @var array<string>

diff --git a/lib/Doctrine/ORM/Mapping/PostLoad.php b/lib/Doctrine/ORM/Mapping/PostLoad.php
@@ -11,6 +11,6 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD)]
-final class PostLoad implements Annotation
+final class PostLoad implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/PostPersist.php b/lib/Doctrine/ORM/Mapping/PostPersist.php
@@ -11,6 +11,6 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD)]
-final class PostPersist implements Annotation
+final class PostPersist implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/PostRemove.php b/lib/Doctrine/ORM/Mapping/PostRemove.php
@@ -11,6 +11,6 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD)]
-final class PostRemove implements Annotation
+final class PostRemove implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/PostUpdate.php b/lib/Doctrine/ORM/Mapping/PostUpdate.php
@@ -11,6 +11,6 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD)]
-final class PostUpdate implements Annotation
+final class PostUpdate implements MappingAttribute
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/PreFlush.php b/lib/Doctrine/ORM/Mapping/PreFlush.php
@@ -11,6 +11,6 @@
  * @Target("METHOD")
  */
 #[Attribute(Attribute::TARGET_METHOD)]
-final class PreFlush implements Annotation
+final class PreFlush implements MappingAttribute
 {
 }