Replace the old exception to status config with the new Symfony's YAML extension for PHP constants

Author: meyerbaptiste

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -186,6 +186,8 @@ private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode)
                                 }
 
                                 if (defined($httpStatusCodeConstant = sprintf('%s::%s', Response::class, $httpStatusCode))) {
+                                    @trigger_error(sprintf('Using a string "%s" as a constant of the "%s" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony\'s custom YAML extension for PHP constants instead (i.e. "!php/const:%s").', $httpStatusCode, Response::class, $httpStatusCodeConstant), E_USER_DEPRECATED);
+
                                     $httpStatusCode = constant($httpStatusCodeConstant);
                                 }
                             }

tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -126,7 +126,7 @@ public function testExceptionToStatusConfig()
             'api_platform' => [
                 'exception_to_status' => [
                     \InvalidArgumentException::class => Response::HTTP_BAD_REQUEST,
-                    \RuntimeException::class => 'HTTP_INTERNAL_SERVER_ERROR',
+                    \RuntimeException::class => Response::HTTP_INTERNAL_SERVER_ERROR,
                 ],
             ],
         ]);
@@ -138,6 +138,26 @@ public function testExceptionToStatusConfig()
         ], $config['exception_to_status']);
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Using a string "HTTP_INTERNAL_SERVER_ERROR" as a constant of the "Symfony\Component\HttpFoundation\Response" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony's custom YAML extension for PHP constants instead (i.e. "!php/const:Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST").
+     */
+    public function testLegacyExceptionToStatusConfig()
+    {
+        $config = $this->processor->processConfiguration($this->configuration, [
+            'api_platform' => [
+                'exception_to_status' => [
+                    \RuntimeException::class => 'HTTP_INTERNAL_SERVER_ERROR',
+                ],
+            ],
+        ]);
+
+        $this->assertTrue(isset($config['exception_to_status']));
+        $this->assertSame([
+            \RuntimeException::class => Response::HTTP_INTERNAL_SERVER_ERROR,
+        ], $config['exception_to_status']);
+    }
+
     public function invalidHttpStatusCodeProvider()
     {
         return [

tests/Fixtures/app/config/config.yml

@@ -48,7 +48,7 @@ api_platform:
     enable_nelmio_api_doc: true
     exception_to_status:
         Symfony\Component\Serializer\Exception\ExceptionInterface: 400
-        ApiPlatform\Core\Exception\InvalidArgumentException: 'HTTP_BAD_REQUEST'
+        ApiPlatform\Core\Exception\InvalidArgumentException: !php/const:Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
     http_cache:
         invalidation:
             enabled: true