[PropertyInfo][Serializer] Fixed extracting ignored properties

javer · nicolas-grekas · commit 594ce465ce1c · 2020-12-10T23:52:33.000+01:00
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/SerializerExtractor.php
@@ -47,7 +47,7 @@ public function getProperties(string $class, array $context = []): ?array
         $serializerClassMetadata = $this->classMetadataFactory->getMetadataFor($class);
 
         foreach ($serializerClassMetadata->getAttributesMetadata() as $serializerAttributeMetadata) {
-            $ignored = method_exists($serializerClassMetadata, 'isIgnored') && $serializerAttributeMetadata->isIgnored();
+            $ignored = method_exists($serializerAttributeMetadata, 'isIgnored') && $serializerAttributeMetadata->isIgnored();
             if (!$ignored && array_intersect($context['serializer_groups'], $serializerAttributeMetadata->getGroups())) {
                 $properties[] = $serializerAttributeMetadata->getName();
             }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/SerializerExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/SerializerExtractorTest.php
@@ -14,6 +14,8 @@
 use Doctrine\Common\Annotations\AnnotationReader;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\PropertyInfo\Extractor\SerializerExtractor;
+use Symfony\Component\PropertyInfo\Tests\Fixtures\IgnorePropertyDummy;
+use Symfony\Component\Serializer\Annotation\Ignore;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
 use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
 
@@ -40,4 +42,13 @@ public function testGetProperties()
             $this->extractor->getProperties('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', ['serializer_groups' => ['a']])
         );
     }
+
+    public function testGetPropertiesWithIgnoredProperties()
+    {
+        if (!class_exists(Ignore::class)) {
+            $this->markTestSkipped('Ignore annotation is not implemented in current symfony/serializer version');
+        }
+
+        $this->assertSame(['visibleProperty'], $this->extractor->getProperties(IgnorePropertyDummy::class, ['serializer_groups' => ['a']]));
+    }
 }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/IgnorePropertyDummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/IgnorePropertyDummy.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyInfo\Tests\Fixtures;
+
+use Symfony\Component\Serializer\Annotation\Groups;
+use Symfony\Component\Serializer\Annotation\Ignore;
+
+/**
+ * @author Vadim Borodavko <vadim.borodavko@gmail.com>
+ */
+class IgnorePropertyDummy
+{
+    /**
+     * @Groups({"a"})
+     */
+    public $visibleProperty;
+
+    /**
+     * @Groups({"a"})
+     * @Ignore
+     */
+    private $ignoredProperty;
+}

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function getProperties(string $class, array $context = []): ?array`
`47`	`47`	`$serializerClassMetadata = $this->classMetadataFactory->getMetadataFor($class);`
`48`	`48`
`49`	`49`	`foreach ($serializerClassMetadata->getAttributesMetadata() as $serializerAttributeMetadata) {`
`50`		`- $ignored = method_exists($serializerClassMetadata, 'isIgnored') && $serializerAttributeMetadata->isIgnored();`
	`50`	`+ $ignored = method_exists($serializerAttributeMetadata, 'isIgnored') && $serializerAttributeMetadata->isIgnored();`
`51`	`51`	`if (!$ignored && array_intersect($context['serializer_groups'], $serializerAttributeMetadata->getGroups())) {`
`52`	`52`	`$properties[] = $serializerAttributeMetadata->getName();`
`53`	`53`	`}`