Merge pull request #1529 from mbabker/annotations-marker-interface

Introduce a marker interface for annotation/attribute classes
schmittjoh · Dec 14, 2023 · 111451f · 111451f
2 parents c586bf6 + 50d7d6e
commit 111451f
Show file tree

Hide file tree

Showing 32 changed files with 70 additions and 87 deletions.
diff --git a/src/Annotation/AccessType.php b/src/Annotation/AccessType.php
@@ -11,7 +11,7 @@
  * @author Johannes M. Schmitt <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY)]
-final class AccessType
+final class AccessType implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Accessor.php b/src/Annotation/Accessor.php
@@ -11,7 +11,7 @@
  * @author Johannes M. Schmitt <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
-final class Accessor
+final class Accessor implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/AccessorOrder.php b/src/Annotation/AccessorOrder.php
@@ -13,7 +13,7 @@
  * @author Johannes M. Schmitt <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-final class AccessorOrder
+final class AccessorOrder implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Discriminator.php b/src/Annotation/Discriminator.php
@@ -9,7 +9,7 @@
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class Discriminator
+class Discriminator implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Exclude.php b/src/Annotation/Exclude.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY", "CLASS", "METHOD", "ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD)]
-final class Exclude
+final class Exclude implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/ExclusionPolicy.php b/src/Annotation/ExclusionPolicy.php
@@ -11,7 +11,7 @@
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-final class ExclusionPolicy
+final class ExclusionPolicy implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Expose.php b/src/Annotation/Expose.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class Expose
+final class Expose implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Groups.php b/src/Annotation/Groups.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class Groups
+final class Groups implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Inline.php b/src/Annotation/Inline.php
@@ -9,6 +9,6 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class Inline
+final class Inline implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/MaxDepth.php b/src/Annotation/MaxDepth.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class MaxDepth
+final class MaxDepth implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/PostDeserialize.php b/src/Annotation/PostDeserialize.php
@@ -16,6 +16,6 @@
  * @author Johannes M. Schmitt <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
-final class PostDeserialize
+final class PostDeserialize implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/PostSerialize.php b/src/Annotation/PostSerialize.php
@@ -9,6 +9,6 @@
  * @Target("METHOD")
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
-final class PostSerialize
+final class PostSerialize implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/PreSerialize.php b/src/Annotation/PreSerialize.php
@@ -17,6 +17,6 @@
  * @author Johannes M. Schmitt <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_METHOD)]
-final class PreSerialize
+final class PreSerialize implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/ReadOnlyProperty.php b/src/Annotation/ReadOnlyProperty.php
@@ -11,7 +11,7 @@
  * @final
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY)]
-/* final */ class ReadOnlyProperty
+/* final */ class ReadOnlyProperty implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/SerializedName.php b/src/Annotation/SerializedName.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY","METHOD", "ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class SerializedName
+final class SerializedName implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/SerializerAttribute.php b/src/Annotation/SerializerAttribute.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Annotation;
+
+/**
+ * Marker interface for serializer attributes
+ */
+interface SerializerAttribute
+{
+}
diff --git a/src/Annotation/SkipWhenEmpty.php b/src/Annotation/SkipWhenEmpty.php
@@ -9,6 +9,6 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class SkipWhenEmpty
+final class SkipWhenEmpty implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/Type.php b/src/Annotation/Type.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY", "METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class Type
+final class Type implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/Version.php b/src/Annotation/Version.php
@@ -4,7 +4,7 @@
 
 namespace JMS\Serializer\Annotation;
 
-abstract class Version
+abstract class Version implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/VirtualProperty.php b/src/Annotation/VirtualProperty.php
@@ -11,7 +11,7 @@
  * @author Alexander Klimenkov <[email protected]>
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
-final class VirtualProperty
+final class VirtualProperty implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlAttribute.php b/src/Annotation/XmlAttribute.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY", "METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class XmlAttribute
+final class XmlAttribute implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlAttributeMap.php b/src/Annotation/XmlAttributeMap.php
@@ -9,6 +9,6 @@
  * @Target({"PROPERTY", "METHOD"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class XmlAttributeMap
+final class XmlAttributeMap implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/XmlCollection.php b/src/Annotation/XmlCollection.php
@@ -4,7 +4,7 @@
 
 namespace JMS\Serializer\Annotation;
 
-abstract class XmlCollection
+abstract class XmlCollection implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlDiscriminator.php b/src/Annotation/XmlDiscriminator.php
@@ -9,7 +9,7 @@
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-class XmlDiscriminator
+class XmlDiscriminator implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlElement.php b/src/Annotation/XmlElement.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY", "METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class XmlElement
+final class XmlElement implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlKeyValuePairs.php b/src/Annotation/XmlKeyValuePairs.php
@@ -9,6 +9,6 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class XmlKeyValuePairs
+final class XmlKeyValuePairs implements SerializerAttribute
 {
 }
diff --git a/src/Annotation/XmlNamespace.php b/src/Annotation/XmlNamespace.php
@@ -9,7 +9,7 @@
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
-final class XmlNamespace
+final class XmlNamespace implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlRoot.php b/src/Annotation/XmlRoot.php
@@ -9,7 +9,7 @@
  * @Target("CLASS")
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
-final class XmlRoot
+final class XmlRoot implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Annotation/XmlValue.php b/src/Annotation/XmlValue.php
@@ -9,7 +9,7 @@
  * @Target({"PROPERTY","METHOD","ANNOTATION"})
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class XmlValue
+final class XmlValue implements SerializerAttribute
 {
     use AnnotationUtilsTrait;
 

diff --git a/src/Metadata/Driver/AnnotationOrAttributeDriver.php b/src/Metadata/Driver/AnnotationOrAttributeDriver.php
@@ -20,6 +20,7 @@
 use JMS\Serializer\Annotation\PreSerialize;
 use JMS\Serializer\Annotation\ReadOnlyProperty;
 use JMS\Serializer\Annotation\SerializedName;
+use JMS\Serializer\Annotation\SerializerAttribute;
 use JMS\Serializer\Annotation\Since;
 use JMS\Serializer\Annotation\SkipWhenEmpty;
 use JMS\Serializer\Annotation\Type;
@@ -48,8 +49,6 @@
 use Metadata\Driver\DriverInterface;
 use Metadata\MethodMetadata;
 
-use function array_filter;
-
 class AnnotationOrAttributeDriver implements DriverInterface
 {
     use ExpressionMetadataTrait;
@@ -300,7 +299,7 @@ public function loadMetadataForClass(\ReflectionClass $class): ?BaseClassMetadat
     }
 
     /**
-     * @return list<object>
+     * @return list<SerializerAttribute>
      */
     protected function getClassAnnotations(\ReflectionClass $class): array
     {
@@ -311,12 +310,7 @@ protected function getClassAnnotations(\ReflectionClass $class): array
                 static function (\ReflectionAttribute $attribute): object {
                     return $attribute->newInstance();
                 },
-                array_filter(
-                    $class->getAttributes(),
-                    static function (\ReflectionAttribute $attribute): bool {
-                        return class_exists($attribute->getName());
-                    }
-                )
+                $class->getAttributes(SerializerAttribute::class, \ReflectionAttribute::IS_INSTANCEOF)
             );
         }
 
@@ -328,7 +322,7 @@ static function (\ReflectionAttribute $attribute): bool {
     }
 
     /**
-     * @return list<object>
+     * @return list<SerializerAttribute>
      */
     protected function getMethodAnnotations(\ReflectionMethod $method): array
     {
@@ -339,12 +333,7 @@ protected function getMethodAnnotations(\ReflectionMethod $method): array
                 static function (\ReflectionAttribute $attribute): object {
                     return $attribute->newInstance();
                 },
-                array_filter(
-                    $method->getAttributes(),
-                    static function (\ReflectionAttribute $attribute): bool {
-                        return class_exists($attribute->getName());
-                    }
-                )
+                $method->getAttributes(SerializerAttribute::class, \ReflectionAttribute::IS_INSTANCEOF)
             );
         }
 
@@ -356,7 +345,7 @@ static function (\ReflectionAttribute $attribute): bool {
     }
 
     /**
-     * @return list<object>
+     * @return list<SerializerAttribute>
      */
     protected function getPropertyAnnotations(\ReflectionProperty $property): array
     {
@@ -367,12 +356,7 @@ protected function getPropertyAnnotations(\ReflectionProperty $property): array
                 static function (\ReflectionAttribute $attribute): object {
                     return $attribute->newInstance();
                 },
-                array_filter(
-                    $property->getAttributes(),
-                    static function (\ReflectionAttribute $attribute): bool {
-                        return class_exists($attribute->getName());
-                    }
-                )
+                $property->getAttributes(SerializerAttribute::class, \ReflectionAttribute::IS_INSTANCEOF)
             );
         }