feature #60870 [Serializer] Remove AdvancedNameConverterInterface (mttsch)

nicolas-grekas · nicolas-grekas · commit ba5e1d600ad2 · 2025-06-23T08:40:26.000+02:00
This PR was merged into the 8.0 branch. Discussion ---------- [Serializer] Remove `AdvancedNameConverterInterface` | Q | A | ------------- | --- | Branch? | 8.0 | Bug fix? | no | New feature? | no | Deprecations? | yes | Issues | | License | MIT  Commits ------- e9a9acd [Serializer] Remove AdvancedNameConverterInterface
diff --git a/UPGRADE-8.0.md b/UPGRADE-8.0.md
@@ -325,6 +325,22 @@ Serializer
 ----------
 
  * Remove `AbstractNormalizerContextBuilder::withDefaultContructorArguments()`, use `withDefaultConstructorArguments()` instead
+ * Change signature of `NameConverterInterface::normalize()` and `NameConverterInterface::denormalize()` methods:
+
+   Before:
+
+   ```php
+   public function normalize(string $propertyName): string;
+   public function denormalize(string $propertyName): string;
+   ```
+
+   After:
+
+   ```php
+   public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
+   public function denormalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
+   ```
+ * Remove `AdvancedNameConverterInterface`, use `NameConverterInterface` instead
 
 TwigBridge
 ----------
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -5,6 +5,22 @@ CHANGELOG
 ---
 
  * Remove `AbstractNormalizerContextBuilder::withDefaultContructorArguments()`, use `withDefaultConstructorArguments()` instead
+ * Change signature of `NameConverterInterface::normalize()` and `NameConverterInterface::denormalize()` methods:
+
+   Before:
+
+   ```php
+   public function normalize(string $propertyName): string;
+   public function denormalize(string $propertyName): string;
+   ```
+
+   After:
+
+   ```php
+   public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
+   public function denormalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
+   ```
+ * Remove `AdvancedNameConverterInterface`, use `NameConverterInterface` instead
 
 7.3
 ---
diff --git a/src/Symfony/Component/Serializer/NameConverter/AdvancedNameConverterInterface.php b/src/Symfony/Component/Serializer/NameConverter/AdvancedNameConverterInterface.php
diff --git a/src/Symfony/Component/Serializer/NameConverter/CamelCaseToSnakeCaseNameConverter.php b/src/Symfony/Component/Serializer/NameConverter/CamelCaseToSnakeCaseNameConverter.php
@@ -41,7 +41,7 @@ public function __construct(
      * @param string|null          $format
      * @param array<string, mixed> $context
      */
-    public function normalize(string $propertyName/* , ?string $class = null, ?string $format = null, array $context = [] */): string
+    public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string
     {
         if (null === $this->attributes || \in_array($propertyName, $this->attributes, true)) {
             return strtolower(preg_replace('/[A-Z]/', '_\\0', lcfirst($propertyName)));
@@ -55,7 +55,7 @@ public function normalize(string $propertyName/* , ?string $class = null, ?strin
      * @param string|null          $format
      * @param array<string, mixed> $context
      */
-    public function denormalize(string $propertyName/* , ?string $class = null, ?string $format = null, array $context = [] */): string
+    public function denormalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string
     {
         $class = 1 < \func_num_args() ? func_get_arg(1) : null;
         $format = 2 < \func_num_args() ? func_get_arg(2) : null;
diff --git a/src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php b/src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php
@@ -18,7 +18,7 @@
 /**
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  */
-final class MetadataAwareNameConverter implements AdvancedNameConverterInterface
+final class MetadataAwareNameConverter implements NameConverterInterface
 {
     /**
      * @var array<string, array<string, string|null>>
diff --git a/src/Symfony/Component/Serializer/NameConverter/NameConverterInterface.php b/src/Symfony/Component/Serializer/NameConverter/NameConverterInterface.php
@@ -25,7 +25,7 @@ interface NameConverterInterface
      * @param string|null          $format
      * @param array<string, mixed> $context
      */
-    public function normalize(string $propertyName/* , ?string $class = null, ?string $format = null, array $context = [] */): string;
+    public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
 
     /**
      * Converts a property name to its denormalized value.
@@ -34,5 +34,5 @@ public function normalize(string $propertyName/* , ?string $class = null, ?strin
      * @param string|null          $format
      * @param array<string, mixed> $context
      */
-    public function denormalize(string $propertyName/* , ?string $class = null, ?string $format = null, array $context = [] */): string;
+    public function denormalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string;
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -28,9 +28,9 @@
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
 use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
 use Symfony\Component\Serializer\Mapping\Loader\YamlFileLoader;
-use Symfony\Component\Serializer\NameConverter\AdvancedNameConverterInterface;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
 use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
@@ -779,9 +779,9 @@ public function testDenormalizeFalsePseudoType()
         $this->assertFalse($object->canBeFalseOrString);
     }
 
-    public function testAdvancedNameConverter()
+    public function testNameConverterProperties()
     {
-        $nameConverter = new class implements AdvancedNameConverterInterface {
+        $nameConverter = new class implements NameConverterInterface {
             public function normalize(string $propertyName, ?string $class = null, ?string $format = null, array $context = []): string
             {
                 return \sprintf('%s-%s-%s-%s', $propertyName, $class, $format, $context['foo']);

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`/**`
`19`	`19`	`* @author Fabien Bourigault <bourigaultfabien@gmail.com>`
`20`	`20`	`*/`
`21`		`-final class MetadataAwareNameConverter implements AdvancedNameConverterInterface`
	`21`	`+final class MetadataAwareNameConverter implements NameConverterInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* @var array<string, array<string, string\|null>>`