fix: GetSetMethodNormalizer::supportss should not check ignored methods

nikophil · nicolas-grekas · commit 3ca371b44993 · 2023-03-17T16:02:00.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.
  *
@@ -85,6 +87,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`	`*`
`@@ -85,6 +87,7 @@ private function isGetMethod(\ReflectionMethod $method): bool`
`85`	`87`
`86`	`88`	`return`
`87`	`89`	`!$method->isStatic() &&`
	`90`	`+ !$method->getAttributes(Ignore::class) &&`
`88`	`91`	`(`
`89`	`92`	`((str_starts_with($method->name, 'get') && 3 < $methodLength) \|\|`
`90`	`93`	`(str_starts_with($method->name, 'is') && 2 < $methodLength) \|\|`