feature #61023 [Serializer] add can to the accessor prefixes recognized by the AttributeLoader (Mark Schmale)

nicolas-grekas · nicolas-grekas · commit cabe552312ee · 2025-07-15T14:48:10.000+02:00
This PR was squashed before being merged into the 7.4 branch. Discussion ---------- [Serializer] add `can` to the accessor prefixes recognized by the `AttributeLoader` | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #61021 | License | MIT The ObjectNormalizer already recognizes `canX` as an accessor and "generates" a property for that, the AttributeLoader does not, so #[Ignore] attributes on `canX` are ignored, the return value is encoded in the normalized data. We just add the `can` prefix ot the list of accepted accessor prefixes, so the AttributeLoader now also recognized these. I adapted a test that _seemd to me_ to fit the best. If you'd prefer a dedicated test for that, I can do that, too. Commits ------- fb1da0b [Serializer] add `can` to the accessor prefixes recognized by the `AttributeLoader`
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.4
+---
+
+ * Add support for `can*()` methods to `AttributeLoader`
+
 7.3
 ---
 
diff --git a/src/Symfony/Component/Serializer/Mapping/Loader/AttributeLoader.php b/src/Symfony/Component/Serializer/Mapping/Loader/AttributeLoader.php
@@ -114,7 +114,7 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool
                 continue; /*  matches the BC behavior in `Symfony\Component\Serializer\Normalizer\ObjectNormalizer::extractAttributes` */
             }
 
-            $accessorOrMutator = preg_match('/^(get|is|has|set)(.+)$/i', $method->name, $matches);
+            $accessorOrMutator = preg_match('/^(get|is|has|set|can)(.+)$/i', $method->name, $matches);
             if ($accessorOrMutator && !ctype_lower($matches[2][0])) {
                 $attributeName = lcfirst($matches[2]);
 
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/Attributes/IgnoreDummy.php b/src/Symfony/Component/Serializer/Tests/Fixtures/Attributes/IgnoreDummy.php
@@ -28,4 +28,10 @@ public function getIgnored2()
     {
         return $this->ignored2;
     }
+
+    #[Ignore]
+    public function canBeIgnored(): bool
+    {
+        return true;
+    }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Mapping/Loader/AttributeLoaderTest.php b/src/Symfony/Component/Serializer/Tests/Mapping/Loader/AttributeLoaderTest.php
@@ -153,6 +153,7 @@ public function testLoadIgnore()
         $attributesMetadata = $classMetadata->getAttributesMetadata();
         $this->assertTrue($attributesMetadata['ignored1']->isIgnored());
         $this->assertTrue($attributesMetadata['ignored2']->isIgnored());
+        $this->assertTrue($attributesMetadata['beIgnored']->isIgnored());
     }
 
     public function testLoadContextsPropertiesPromoted()

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public function loadClassMetadata(ClassMetadataInterface $classMetadata): bool`
`114`	`114`	continue; /* matches the BC behavior in `Symfony\Component\Serializer\Normalizer\ObjectNormalizer::extractAttributes` */
`115`	`115`	`}`
`116`	`116`
`117`		`- $accessorOrMutator = preg_match('/^(get\|is\|has\|set)(.+)$/i', $method->name, $matches);`
	`117`	`+ $accessorOrMutator = preg_match('/^(get\|is\|has\|set\|can)(.+)$/i', $method->name, $matches);`
`118`	`118`	`if ($accessorOrMutator && !ctype_lower($matches[2][0])) {`
`119`	`119`	`$attributeName = lcfirst($matches[2]);`
`120`	`120`
Original file line number	Diff line number	Diff line change
`@@ -28,4 +28,10 @@ public function getIgnored2()`
`28`	`28`	`{`
`29`	`29`	`return $this->ignored2;`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+ #[Ignore]`
	`33`	`+ public function canBeIgnored(): bool`
	`34`	`+ {`
	`35`	`+ return true;`
	`36`	`+ }`
`31`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,7 @@ public function testLoadIgnore()`
`153`	`153`	`$attributesMetadata = $classMetadata->getAttributesMetadata();`
`154`	`154`	`$this->assertTrue($attributesMetadata['ignored1']->isIgnored());`
`155`	`155`	`$this->assertTrue($attributesMetadata['ignored2']->isIgnored());`
	`156`	`+ $this->assertTrue($attributesMetadata['beIgnored']->isIgnored());`
`156`	`157`	`}`
`157`	`158`
`158`	`159`	`public function testLoadContextsPropertiesPromoted()`