feature #45282 [Serializer] Support canners in object normalizer (rmikalkenas)

fabpot · fabpot · commit bf39ec469d07 · 2022-04-27T19:08:15.000+02:00
This PR was merged into the 6.1 branch. Discussion ---------- [Serializer] Support canners in object normalizer | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Noticed that serializer is not capable of normalizing properties with methods that start with `can` prefix, even though property info component has support for it. I think it's inconsistent and serializer should support it as well. Targeting 6.1 branch as this sounds like a new feature (correct me if wrong). Also not sure about BC as this change might break others code (until this change, properties with can methods were silently skipped from normalization) Commits ------- c3cb4f5 [Serializer] Support canners in object normalizer
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * Deprecate `ContextAwareDecoderInterface`, use `DecoderInterface` instead
  * Deprecate supporting denormalization for `AbstractUid` in `UidNormalizer`, use one of `AbstractUid` child class instead
  * Deprecate denormalizing to an abstract class in `UidNormalizer`
+ * Add support for `can*()` methods to `ObjectNormalizer`
 
 6.0
 ---
diff --git a/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php
@@ -86,8 +86,8 @@ protected function extractAttributes(object $object, string $format = null, arra
             $name = $reflMethod->name;
             $attributeName = null;
 
-            if (str_starts_with($name, 'get') || str_starts_with($name, 'has')) {
-                // getters and hassers
+            if (str_starts_with($name, 'get') || str_starts_with($name, 'has') || str_starts_with($name, 'can')) {
+                // getters, hassers and canners
                 $attributeName = substr($name, 3);
 
                 if (!$reflClass->hasProperty($attributeName)) {
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/Features/ObjectDummy.php b/src/Symfony/Component/Serializer/Tests/Normalizer/Features/ObjectDummy.php
@@ -22,6 +22,7 @@ class ObjectDummy
     private $baz;
     protected $camelCase;
     protected $object;
+    private $go;
 
     public function getFoo()
     {
@@ -72,4 +73,14 @@ public function getObject()
     {
         return $this->object;
     }
+
+    public function setGo($go)
+    {
+        $this->go = $go;
+    }
+
+    public function canGo()
+    {
+        return $this->go;
+    }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -107,6 +107,7 @@ public function testNormalize()
         $obj->setBaz(true);
         $obj->setCamelCase('camelcase');
         $obj->setObject($object);
+        $obj->setGo(true);
 
         $this->serializer
             ->expects($this->once())
@@ -123,6 +124,7 @@ public function testNormalize()
                 'fooBar' => 'foobar',
                 'camelCase' => 'camelcase',
                 'object' => 'string_object',
+                'go' => true,
             ],
             $this->normalizer->normalize($obj, 'any')
         );
@@ -669,6 +671,7 @@ public function testNormalizeNotSerializableContext()
             'camelCase' => null,
             'object' => null,
             'bar' => null,
+            'go' => null,
         ];
 
         $this->assertEquals($expected, $this->normalizer->normalize($objectDummy, null, ['not_serializable' => function () {
@@ -805,6 +808,7 @@ public function testDefaultObjectClassResolver()
         $obj->setBaz(true);
         $obj->setCamelCase('camelcase');
         $obj->unwantedProperty = 'notwanted';
+        $obj->setGo(false);
 
         $this->assertEquals(
             [
@@ -814,6 +818,7 @@ public function testDefaultObjectClassResolver()
                 'fooBar' => 'foobar',
                 'camelCase' => 'camelcase',
                 'object' => null,
+                'go' => false,
             ],
             $normalizer->normalize($obj, 'any')
         );
@@ -842,6 +847,7 @@ public function testObjectClassResolver()
                 'fooBar' => 'foobar',
                 'camelCase' => 'camelcase',
                 'object' => null,
+                'go' => null,
             ],
             $normalizer->normalize($obj, 'any')
         );

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ class ObjectDummy`
`22`	`22`	`private $baz;`
`23`	`23`	`protected $camelCase;`
`24`	`24`	`protected $object;`
	`25`	`+ private $go;`
`25`	`26`
`26`	`27`	`public function getFoo()`
`27`	`28`	`{`
`@@ -72,4 +73,14 @@ public function getObject()`
`72`	`73`	`{`
`73`	`74`	`return $this->object;`
`74`	`75`	`}`
	`76`	`+`
	`77`	`+ public function setGo($go)`
	`78`	`+ {`
	`79`	`+ $this->go = $go;`
	`80`	`+ }`
	`81`	`+`
	`82`	`+ public function canGo()`
	`83`	`+ {`
	`84`	`+ return $this->go;`
	`85`	`+ }`
`75`	`86`	`}`