[Serializer] Allow Context to target class

mtarld · mtarld · commit dfcec29218f5 · 2023-09-11T18:03:52.000+02:00
diff --git a/src/Symfony/Component/Serializer/Annotation/Context.php b/src/Symfony/Component/Serializer/Annotation/Context.php
@@ -17,12 +17,14 @@
  * Annotation class for @Context().
  *
  * @Annotation
+ *
  * @NamedArgumentConstructor
+ *
  * @Target({"PROPERTY", "METHOD"})
  *
  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  */
-#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class Context
 {
     private array $groups;
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 6.4
 ---
 
+ * Allow `Context` attribute to target class
  * Deprecate Doctrine annotations support in favor of native attributes
  * Deprecate passing an annotation reader to the constructor of `AnnotationLoader`
  * Allow the `Groups` attribute/annotation on classes
diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/AnnotationLoader.php
@@ -57,6 +57,7 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
         $className = $reflectionClass->name;
         $loaded = false;
         $classGroups = [];
+        $classContextAnnotation = null;
 
         $attributesMetadata = $classMetadata->getAttributesMetadata();
 
@@ -71,6 +72,12 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
 
             if ($annotation instanceof Groups) {
                 $classGroups = $annotation->getGroups();
+
+                continue;
+            }
+
+            if ($annotation instanceof Context) {
+                $classContextAnnotation = $annotation;
             }
         }
 
@@ -81,6 +88,10 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
             }
 
             if ($property->getDeclaringClass()->name === $className) {
+                if (null !== $classContextAnnotation) {
+                    $this->setAttributeContextsForGroups($annotation, $attributesMetadata[$property->name]);
+                }
+
                 foreach ($classGroups as $group) {
                     $attributesMetadata[$property->name]->addGroup($group);
                 }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/Features/ContextMetadataTestTrait.php b/src/Symfony/Component/Serializer/Tests/Normalizer/Features/ContextMetadataTestTrait.php
@@ -82,6 +82,7 @@ public function contextMetadataDummyProvider(): array
         return [
             [ContextMetadataDummy::class],
             [ContextChildMetadataDummy::class],
+            [ClassAndPropertyContextMetadataDummy::class],
         ];
     }
 
@@ -133,6 +134,24 @@ class ContextChildMetadataDummy
     public $date;
 }
 
+#[Context(context: [DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339])]
+#[Context(
+    context: [DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339_EXTENDED],
+    groups: ['extended'],
+)]
+class ClassAndPropertyContextMetadataDummy
+{
+    /**
+     * @var \DateTime
+     */
+    #[Groups(['extended', 'simple'])]
+    #[Context(
+        denormalizationContext: [DateTimeNormalizer::FORMAT_KEY => 'd/m/Y'],
+        groups: ['simple'],
+    )]
+    public $date;
+}
+
 class ContextMetadataNamingDummy
 {
     /**
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/Features/DummyContextChild.php b/src/Symfony/Component/Serializer/Tests/Normalizer/Features/DummyContextChild.php
@@ -13,7 +13,7 @@
 
 use Symfony\Component\Serializer\Annotation\Context;
 
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE)]
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE)]
 class DummyContextChild extends Context
 {
 }

Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,14 @@`
`17`	`17`	`* Annotation class for @Context().`
`18`	`18`	`*`
`19`	`19`	`* @Annotation`
	`20`	`+ *`
`20`	`21`	`* @NamedArgumentConstructor`
	`22`	`+ *`
`21`	`23`	`* @Target({"PROPERTY", "METHOD"})`
`22`	`24`	`*`
`23`	`25`	`* @author Maxime Steinhausser <maxime.steinhausser@gmail.com>`
`24`	`26`	`*/`
`25`		`-#[\Attribute(\Attribute::TARGET_PROPERTY \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
	`27`	`+#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::TARGET_PROPERTY \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
`26`	`28`	`class Context`
`27`	`29`	`{`
`28`	`30`	`private array $groups;`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Serializer\Annotation\Context;`
`15`	`15`
`16`		`-#[\Attribute(\Attribute::TARGET_METHOD \| \Attribute::TARGET_PROPERTY \| \Attribute::IS_REPEATABLE)]`
	`16`	`+#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::TARGET_METHOD \| \Attribute::TARGET_PROPERTY \| \Attribute::IS_REPEATABLE)]`
`17`	`17`	`class DummyContextChild extends Context`
`18`	`18`	`{`
`19`	`19`	`}`