[Serializer] Allow Context to target classes

mtarld · nicolas-grekas · commit caaf0a6b71c3 · 2023-09-14T12:05:40.000+02:00
diff --git a/src/Symfony/Component/Serializer/Annotation/Context.php b/src/Symfony/Component/Serializer/Annotation/Context.php
@@ -22,7 +22,7 @@
  *
  * @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 classes
  * 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 ($classContextAnnotation) {
+                    $this->setAttributeContextsForGroups($classContextAnnotation, $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],
         ];
     }
 
@@ -100,7 +101,7 @@ public function testContextDenormalizeWithNameConverter()
 class ContextMetadataDummy
 {
     /**
-     * @var \DateTime
+     * @var \DateTimeImmutable
      */
     #[Groups(['extended', 'simple'])]
     #[Context([DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339])]
@@ -118,7 +119,7 @@ class ContextMetadataDummy
 class ContextChildMetadataDummy
 {
     /**
-     * @var \DateTime
+     * @var \DateTimeImmutable
      */
     #[Groups(['extended', 'simple'])]
     #[DummyContextChild([DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339])]
@@ -133,10 +134,28 @@ class ContextChildMetadataDummy
     public $date;
 }
 
+#[Context(context: [DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339])]
+#[Context(
+    context: [DateTimeNormalizer::FORMAT_KEY => \DateTimeInterface::RFC3339_EXTENDED],
+    groups: ['extended'],
+)]
+class ClassAndPropertyContextMetadataDummy
+{
+    /**
+     * @var \DateTimeImmutable
+     */
+    #[Groups(['extended', 'simple'])]
+    #[Context(
+        denormalizationContext: [DateTimeNormalizer::FORMAT_KEY => 'd/m/Y'],
+        groups: ['simple'],
+    )]
+    public $date;
+}
+
 class ContextMetadataNamingDummy
 {
     /**
-     * @var \DateTime
+     * @var \DateTimeImmutable
      */
     #[Context([DateTimeNormalizer::FORMAT_KEY => 'd/m/Y'])]
     public $createdAt;
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
 {
 }
diff --git a/src/Symfony/Component/Serializer/Tests/SerializerTest.php b/src/Symfony/Component/Serializer/Tests/SerializerTest.php
@@ -1477,12 +1477,12 @@ public function __construct($value)
 class DummyUnionType
 {
     /**
-     * @var \DateTime|bool|null
+     * @var \DateTimeImmutable|bool|null
      */
     public $changed = false;
 
     /**
-     * @param \DateTime|bool|null
+     * @param \DateTimeImmutable|bool|null
      *
      * @return $this
      */

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*`
`23`	`23`	`* @author Maxime Steinhausser <maxime.steinhausser@gmail.com>`
`24`	`24`	`*/`
`25`		`-#[\Attribute(\Attribute::TARGET_PROPERTY \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
	`25`	`+#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::TARGET_PROPERTY \| \Attribute::TARGET_METHOD \| \Attribute::IS_REPEATABLE)]`
`26`	`26`	`class Context`
`27`	`27`	`{`
`28`	`28`	`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`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1477,12 +1477,12 @@ public function __construct($value)`
`1477`	`1477`	`class DummyUnionType`
`1478`	`1478`	`{`
`1479`	`1479`	`/**`
`1480`		`- * @var \DateTime\|bool\|null`
	`1480`	`+ * @var \DateTimeImmutable\|bool\|null`
`1481`	`1481`	`*/`
`1482`	`1482`	`public $changed = false;`
`1483`	`1483`
`1484`	`1484`	`/**`
`1485`		`- * @param \DateTime\|bool\|null`
	`1485`	`+ * @param \DateTimeImmutable\|bool\|null`
`1486`	`1486`	`*`
`1487`	`1487`	`* @return $this`
`1488`	`1488`	`*/`