fix: GetSetMethodNormalizer::supportss should not check ignored methods

nikophil · nikophil · commit 858c233eebc7 · 2023-03-17T14:53:26.000+01:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\Serializer\Annotation\Ignore;
+
 /**
  * Converts between objects with getter and setter methods and arrays.
  *
@@ -36,17 +38,11 @@ class GetSetMethodNormalizer extends AbstractObjectNormalizer
 {
     private static $setterAccessibleCache = [];
 
-    /**
-     * @param array $context
-     */
     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */): bool
     {
         return parent::supportsNormalization($data, $format) && $this->supports($data::class);
     }
 
-    /**
-     * @param array $context
-     */
     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */): bool
     {
         return parent::supportsDenormalization($data, $type, $format) && $this->supports($type);
@@ -82,6 +78,7 @@ private function isGetMethod(\ReflectionMethod $method): bool
 
         return
             !$method->isStatic() &&
+            !$method->getAttributes(Ignore::class) &&
             (
                 ((str_starts_with($method->name, 'get') && 3 < $methodLength) ||
                 (str_starts_with($method->name, 'is') && 2 < $methodLength) ||
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/GetSetMethodNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/GetSetMethodNormalizerTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
+use Symfony\Component\Serializer\Annotation\Ignore;
 use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
 use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
@@ -430,6 +431,11 @@ public function testNoStaticGetSetSupport()
         $this->assertFalse($this->normalizer->supportsNormalization(new ObjectWithJustStaticSetterDummy()));
     }
 
+    public function testNotIgnoredMethodSupport()
+    {
+        $this->assertFalse($this->normalizer->supportsNormalization(new ClassWithIgnoreAttribute()));
+    }
+
     public function testPrivateSetter()
     {
         $obj = $this->normalizer->denormalize(['foo' => 'foobar'], ObjectWithPrivateSetterDummy::class);
@@ -753,3 +759,14 @@ public function __call($key, $value)
         throw new \RuntimeException('__call should not be called. Called with: '.$key);
     }
 }
+
+class ClassWithIgnoreAttribute
+{
+    public string $foo;
+
+    #[Ignore]
+    public function isSomeIgnoredMethod(): bool
+    {
+        return true;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Serializer\Normalizer;`
`13`	`13`
	`14`	`+use Symfony\Component\Serializer\Annotation\Ignore;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Converts between objects with getter and setter methods and arrays.`
`16`	`18`	`*`
`@@ -36,17 +38,11 @@ class GetSetMethodNormalizer extends AbstractObjectNormalizer`
`36`	`38`	`{`
`37`	`39`	`private static $setterAccessibleCache = [];`
`38`	`40`
`39`		`- /**`
`40`		`- * @param array $context`
`41`		`- */`
`42`	`41`	`public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */): bool`
`43`	`42`	`{`
`44`	`43`	`return parent::supportsNormalization($data, $format) && $this->supports($data::class);`
`45`	`44`	`}`
`46`	`45`
`47`		`- /**`
`48`		`- * @param array $context`
`49`		`- */`
`50`	`46`	`public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */): bool`
`51`	`47`	`{`
`52`	`48`	`return parent::supportsDenormalization($data, $type, $format) && $this->supports($type);`
`@@ -82,6 +78,7 @@ private function isGetMethod(\ReflectionMethod $method): bool`
`82`	`78`
`83`	`79`	`return`
`84`	`80`	`!$method->isStatic() &&`
	`81`	`+ !$method->getAttributes(Ignore::class) &&`
`85`	`82`	`(`
`86`	`83`	`((str_starts_with($method->name, 'get') && 3 < $methodLength) \|\|`
`87`	`84`	`(str_starts_with($method->name, 'is') && 2 < $methodLength) \|\|`