[DependencyInjection][FrameworkBundle] Fix using PHP 8.1 enum as parameters

Author: ogizanagi

Console/Descriptor/Descriptor.php

@@ -168,6 +168,20 @@ protected function formatValue($value): string
      */
     protected function formatParameter($value): string
     {
+        if ($value instanceof \UnitEnum) {
+            return var_export($value, true);
+        }
+
+        // Recursively search for enum values, so we can replace it
+        // before json_encode (which will not display anything for \UnitEnum otherwise)
+        if (\is_array($value)) {
+            array_walk_recursive($value, static function (&$value) {
+                if ($value instanceof \UnitEnum) {
+                    $value = var_export($value, true);
+                }
+            });
+        }
+
         if (\is_bool($value) || \is_array($value) || (null === $value)) {
             $jsonString = json_encode($value);
 

Console/Descriptor/JsonDescriptor.php

@@ -158,6 +158,14 @@ private function writeData(array $data, array $options)
     {
         $flags = $options['json_encoding'] ?? 0;
 
+        // Recursively search for enum values, so we can replace it
+        // before json_encode (which will not display anything for \UnitEnum otherwise)
+        array_walk_recursive($data, static function (&$value) {
+            if ($value instanceof \UnitEnum) {
+                $value = var_export($value, true);
+            }
+        });
+
         $this->write(json_encode($data, $flags | \JSON_PRETTY_PRINT)."\n");
     }
 

Console/Descriptor/TextDescriptor.php

@@ -342,6 +342,8 @@ protected function describeContainerDefinition(Definition $definition, array $op
                     $argumentsInformation[] = sprintf('Service locator (%d element(s))', \count($argument->getValues()));
                 } elseif ($argument instanceof Definition) {
                     $argumentsInformation[] = 'Inlined Service';
+                } elseif ($argument instanceof \UnitEnum) {
+                    $argumentsInformation[] = var_export($argument, true);
                 } else {
                     $argumentsInformation[] = \is_array($argument) ? sprintf('Array (%d element(s))', \count($argument)) : $argument;
                 }

Console/Descriptor/XmlDescriptor.php

@@ -386,6 +386,9 @@ private function getArgumentNodes(array $arguments, \DOMDocument $dom): array
                 foreach ($this->getArgumentNodes($argument, $dom) as $childArgumentXML) {
                     $argumentXML->appendChild($childArgumentXML);
                 }
+            } elseif ($argument instanceof \UnitEnum) {
+                $argumentXML->setAttribute('type', 'constant');
+                $argumentXML->appendChild(new \DOMText(var_export($argument, true)));
             } else {
                 $argumentXML->appendChild(new \DOMText($argument));
             }

Controller/AbstractController.php

@@ -58,7 +58,7 @@ public function setContainer(ContainerInterface $container): ?ContainerInterface
     /**
      * Gets a container parameter by its name.
      *
-     * @return array|bool|float|int|string|null
+     * @return array|bool|float|int|string|\UnitEnum|null
      *
      * @final
      */

Controller/Controller.php

@@ -31,7 +31,7 @@ abstract class Controller implements ContainerAwareInterface
     /**
      * Gets a container configuration parameter by its name.
      *
-     * @return array|bool|float|int|string|null
+     * @return array|bool|float|int|string|\UnitEnum|null
      *
      * @final
      */

Test/TestContainer.php

@@ -59,7 +59,7 @@ public function getParameterBag(): ParameterBagInterface
     /**
      * {@inheritdoc}
      *
-     * @return array|bool|float|int|string|null
+     * @return array|bool|float|int|string|\UnitEnum|null
      */
     public function getParameter($name)
     {

Tests/Console/Descriptor/AbstractDescriptorTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\FooUnitEnum;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\BufferedOutput;
 use Symfony\Component\Console\Style\SymfonyStyle;
@@ -121,6 +122,10 @@ public function getDescribeContainerDefinitionWithArgumentsShownTestData()
             $definitionsWithArgs[str_replace('definition_', 'definition_arguments_', $key)] = $definition;
         }
 
+        if (\PHP_VERSION_ID >= 80100) {
+            $definitionsWithArgs['definition_arguments_with_enum'] = (new Definition('definition_with_enum'))->setArgument(0, FooUnitEnum::FOO);
+        }
+
         return $this->getDescriptionTestData($definitionsWithArgs);
     }
 
@@ -248,7 +253,7 @@ private function assertDescription($expectedDescription, $describedObject, array
         }
     }
 
-    private function getDescriptionTestData(array $objects)
+    private function getDescriptionTestData(iterable $objects)
     {
         $data = [];
         foreach ($objects as $name => $object) {

Tests/Console/Descriptor/ObjectsProvider.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor;
 
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\FooUnitEnum;
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Suit;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -61,14 +63,26 @@ public static function getRoutes()
 
     public static function getContainerParameters()
     {
-        return [
-            'parameters_1' => new ParameterBag([
-                'integer' => 12,
-                'string' => 'Hello world!',
-                'boolean' => true,
-                'array' => [12, 'Hello world!', true],
-            ]),
-        ];
+        yield 'parameters_1' => new ParameterBag([
+            'integer' => 12,
+            'string' => 'Hello world!',
+            'boolean' => true,
+            'array' => [12, 'Hello world!', true],
+        ]);
+
+        if (\PHP_VERSION_ID < 80100) {
+            return;
+        }
+
+        yield 'parameters_enums' => new ParameterBag([
+            'unit_enum' => FooUnitEnum::BAR,
+            'backed_enum' => Suit::Hearts,
+            'array_of_enums' => Suit::cases(),
+            'map' => [
+                'mixed' => [Suit::Hearts, FooUnitEnum::BAR],
+                'single' => FooUnitEnum::BAR,
+            ],
+        ]);
     }
 
     public static function getContainerParameter()

Tests/Fixtures/Descriptor/definition_arguments_with_enum.json

@@ -0,0 +1,15 @@
+{
+    "class": "definition_with_enum",
+    "public": false,
+    "synthetic": false,
+    "lazy": false,
+    "shared": true,
+    "abstract": false,
+    "autowire": false,
+    "autoconfigure": false,
+    "arguments": [
+        "Symfony\\Bundle\\FrameworkBundle\\Tests\\Fixtures\\FooUnitEnum::FOO"
+    ],
+    "file": null,
+    "tags": []
+}