deprecated FlattenException::create()

fabpot · fabpot · commit 640ede48be22 · 2019-06-27T16:11:29.000+02:00
diff --git a/src/Symfony/Bundle/TwigBundle/Controller/PreviewErrorController.php b/src/Symfony/Bundle/TwigBundle/Controller/PreviewErrorController.php
@@ -35,7 +35,7 @@ public function __construct(HttpKernelInterface $kernel, $controller)
 
     public function previewErrorPageAction(Request $request, $code)
     {
-        $exception = FlattenException::create(new \Exception('Something has intentionally gone wrong.'), $code);
+        $exception = FlattenException::createFromThrowable(new \Exception('Something has intentionally gone wrong.'), $code);
 
         /*
          * This Request mimics the parameters set by
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/Controller/ExceptionControllerTest.php b/src/Symfony/Bundle/TwigBundle/Tests/Controller/ExceptionControllerTest.php
@@ -26,7 +26,7 @@ public function testShowActionCanBeForcedToShowErrorPage()
 
         $request = $this->createRequest('html');
         $request->attributes->set('showException', false);
-        $exception = FlattenException::create(new \Exception(), 404);
+        $exception = FlattenException::createFromThrowable(new \Exception(), 404);
         $controller = new ExceptionController($twig, /* "showException" defaults to --> */ true);
 
         $response = $controller->showAction($request, $exception, null);
@@ -40,7 +40,7 @@ public function testFallbackToHtmlIfNoTemplateForRequestedFormat()
         $twig = $this->createTwigEnv(['@Twig/Exception/error.html.twig' => '<html></html>']);
 
         $request = $this->createRequest('txt');
-        $exception = FlattenException::create(new \Exception());
+        $exception = FlattenException::createFromThrowable(new \Exception());
         $controller = new ExceptionController($twig, false);
 
         $controller->showAction($request, $exception);
@@ -54,7 +54,7 @@ public function testFallbackToHtmlWithFullExceptionIfNoTemplateForRequestedForma
 
         $request = $this->createRequest('txt');
         $request->attributes->set('showException', true);
-        $exception = FlattenException::create(new \Exception());
+        $exception = FlattenException::createFromThrowable(new \Exception());
         $controller = new ExceptionController($twig, false);
 
         $controller->showAction($request, $exception);
@@ -67,7 +67,7 @@ public function testResponseHasRequestedMimeType()
         $twig = $this->createTwigEnv(['@Twig/Exception/error.json.twig' => '{}']);
 
         $request = $this->createRequest('json');
-        $exception = FlattenException::create(new \Exception());
+        $exception = FlattenException::createFromThrowable(new \Exception());
         $controller = new ExceptionController($twig, false);
 
         $response = $controller->showAction($request, $exception);
diff --git a/src/Symfony/Bundle/WebProfilerBundle/composer.json b/src/Symfony/Bundle/WebProfilerBundle/composer.json
@@ -18,6 +18,7 @@
     "require": {
         "php": "^7.1.3",
         "symfony/config": "^4.2|^5.0",
+        "symfony/error-handler": "^4.4|^5.0",
         "symfony/http-kernel": "^4.4",
         "symfony/routing": "^3.4|^4.0|^5.0",
         "symfony/twig-bundle": "^4.2|^5.0",
diff --git a/src/Symfony/Component/Debug/Exception/FlattenException.php b/src/Symfony/Component/Debug/Exception/FlattenException.php
@@ -20,4 +20,13 @@
  */
 class FlattenException extends BaseFlattenException
 {
+    /**
+     * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception::createFromThrowable() instead.
+     */
+    public static function create(\Exception $exception, $statusCode = null, array $headers = []): self
+    {
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception::createFromThrowable() instead.', __METHOD__), E_USER_DEPRECATED);
+
+        return parent::createFromThrowable($exception, $statusCode, $headers);
+    }
 }
diff --git a/src/Symfony/Component/ErrorHandler/ErrorRenderer/ErrorRenderer.php b/src/Symfony/Component/ErrorHandler/ErrorRenderer/ErrorRenderer.php
@@ -62,8 +62,8 @@ public function render($exception, string $format = 'html'): string
             throw new ErrorRendererNotFoundException(sprintf('No error renderer found for format "%s".', $format));
         }
 
-        if ($exception instanceof \Exception) {
-            $exception = FlattenException::create($exception);
+        if ($exception instanceof \Throwable) {
+            $exception = FlattenException::createFromThrowable($exception);
         }
 
         return $this->renderers[$format]->render($exception);
diff --git a/src/Symfony/Component/ErrorHandler/ErrorRenderer/HtmlErrorRenderer.php b/src/Symfony/Component/ErrorHandler/ErrorRenderer/HtmlErrorRenderer.php
@@ -150,7 +150,7 @@ public function getBody(FlattenException $exception)
         } catch (\Exception $e) {
             // something nasty happened and we cannot throw an exception anymore
             if ($this->debug) {
-                $e = FlattenException::create($e);
+                $e = FlattenException::createFromThrowable($e);
                 $exceptionMessage = sprintf('Exception thrown when handling an exception (%s: %s)', $e->getClass(), $this->escapeHtml($e->getMessage()));
             } else {
                 $exceptionMessage = 'Whoops, looks like something went wrong.';
diff --git a/src/Symfony/Component/ErrorHandler/Exception/FlattenException.php b/src/Symfony/Component/ErrorHandler/Exception/FlattenException.php
@@ -36,11 +36,6 @@ class FlattenException
     private $file;
     private $line;
 
-    public static function create(\Exception $exception, $statusCode = null, array $headers = [])
-    {
-        return static::createFromThrowable($exception, $statusCode, $headers);
-    }
-
     public static function createFromThrowable(\Throwable $exception, ?int $statusCode = null, array $headers = []): self
     {
         $e = new static();
diff --git a/src/Symfony/Component/ErrorHandler/ExceptionHandler.php b/src/Symfony/Component/ErrorHandler/ExceptionHandler.php
@@ -160,8 +160,8 @@ public function handle(\Exception $exception)
      */
     public function sendPhpResponse($exception)
     {
-        if ($exception instanceof \Exception) {
-            $exception = FlattenException::create($exception);
+        if ($exception instanceof \Throwable) {
+            $exception = FlattenException::createFromThrowable($exception);
         }
 
         if (!headers_sent()) {
diff --git a/src/Symfony/Component/ErrorHandler/Tests/DependencyInjection/ErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/DependencyInjection/ErrorRendererTest.php
@@ -27,7 +27,7 @@ public function testInvalidErrorRenderer()
         $container = $this->getMockBuilder('Psr\Container\ContainerInterface')->getMock();
         $container->expects($this->once())->method('has')->with('foo')->willReturn(false);
 
-        $exception = FlattenException::create(new \Exception('Foo'));
+        $exception = FlattenException::createFromThrowable(new \Exception('Foo'));
         (new ErrorRenderer($container))->render($exception, 'foo');
     }
 
@@ -48,7 +48,7 @@ public function testCustomErrorRenderer()
 
         $errorRenderer = new ErrorRenderer($container);
 
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $this->assertSame('Foo', $errorRenderer->render($exception, 'foo'));
     }
 }
diff --git a/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/ErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/ErrorRendererTest.php
@@ -24,7 +24,7 @@ class ErrorRendererTest extends TestCase
      */
     public function testErrorRendererNotFound()
     {
-        $exception = FlattenException::create(new \Exception('foo'));
+        $exception = FlattenException::createFromThrowable(new \Exception('foo'));
         (new ErrorRenderer([]))->render($exception, 'foo');
     }
 
@@ -34,7 +34,7 @@ public function testErrorRendererNotFound()
      */
     public function testInvalidErrorRenderer()
     {
-        $exception = FlattenException::create(new \Exception('foo'));
+        $exception = FlattenException::createFromThrowable(new \Exception('foo'));
         (new ErrorRenderer([new \stdClass()]))->render($exception, 'foo');
     }
 
@@ -43,7 +43,7 @@ public function testCustomErrorRenderer()
         $renderers = [new FooErrorRenderer()];
         $errorRenderer = new ErrorRenderer($renderers);
 
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $this->assertSame('Foo', $errorRenderer->render($exception, 'foo'));
     }
 }
diff --git a/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/HtmlErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/HtmlErrorRendererTest.php
@@ -19,7 +19,7 @@ class HtmlErrorRendererTest extends TestCase
 {
     public function testRender()
     {
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $expected = '<!DOCTYPE html>%A<html>%A<head>%A<title>Internal Server Error</title>%A<h1 class="break-long-words exception-message">Foo</h1>%A<abbr title="RuntimeException">RuntimeException</abbr>%A';
 
         $this->assertStringMatchesFormat($expected, (new HtmlErrorRenderer())->render($exception));
diff --git a/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/JsonErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/JsonErrorRendererTest.php
@@ -19,7 +19,7 @@ class JsonErrorRendererTest extends TestCase
 {
     public function testRender()
     {
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $expected = '{"title":"Internal Server Error","status":500,"detail":"Foo","exceptions":[{"message":"Foo","class":"RuntimeException","trace":';
 
         $this->assertStringStartsWith($expected, (new JsonErrorRenderer())->render($exception));
diff --git a/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/TxtErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/TxtErrorRendererTest.php
@@ -19,7 +19,7 @@ class TxtErrorRendererTest extends TestCase
 {
     public function testRender()
     {
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $expected = '[title] Internal Server Error%A[status] 500%A[detail] Foo%A[1] RuntimeException: Foo%A';
 
         $this->assertStringMatchesFormat($expected, (new TxtErrorRenderer())->render($exception));
diff --git a/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/XmlErrorRendererTest.php b/src/Symfony/Component/ErrorHandler/Tests/ErrorRenderer/XmlErrorRendererTest.php
@@ -19,7 +19,7 @@ class XmlErrorRendererTest extends TestCase
 {
     public function testRender()
     {
-        $exception = FlattenException::create(new \RuntimeException('Foo'));
+        $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));
         $expected = '<?xml version="1.0" encoding="UTF-8" ?>%A<problem xmlns="urn:ietf:rfc:7807">%A<title>Internal Server Error</title>%A<status>500</status>%A<detail>Foo</detail>%A';
 
         $this->assertStringMatchesFormat($expected, (new XmlErrorRenderer())->render($exception));
diff --git a/src/Symfony/Component/ErrorHandler/Tests/Exception/FlattenExceptionTest.php b/src/Symfony/Component/ErrorHandler/Tests/Exception/FlattenExceptionTest.php
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/ExceptionDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/ExceptionDataCollector.php
diff --git a/src/Symfony/Component/HttpKernel/EventListener/ExceptionListener.php b/src/Symfony/Component/HttpKernel/EventListener/ExceptionListener.php
diff --git a/src/Symfony/Component/HttpKernel/Tests/DataCollector/ExceptionDataCollectorTest.php b/src/Symfony/Component/HttpKernel/Tests/DataCollector/ExceptionDataCollectorTest.php
diff --git a/src/Symfony/Component/Messenger/composer.json b/src/Symfony/Component/Messenger/composer.json

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(HttpKernelInterface $kernel, $controller)`
`35`	`35`
`36`	`36`	`public function previewErrorPageAction(Request $request, $code)`
`37`	`37`	`{`
`38`		`- $exception = FlattenException::create(new \Exception('Something has intentionally gone wrong.'), $code);`
	`38`	`+ $exception = FlattenException::createFromThrowable(new \Exception('Something has intentionally gone wrong.'), $code);`
`39`	`39`
`40`	`40`	`/*`
`41`	`41`	`* This Request mimics the parameters set by`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,13 @@`
`20`	`20`	`*/`
`21`	`21`	`class FlattenException extends BaseFlattenException`
`22`	`22`	`{`
	`23`	`+ /**`
	`24`	`+ * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception::createFromThrowable() instead.`
	`25`	`+ */`
	`26`	`+ public static function create(\Exception $exception, $statusCode = null, array $headers = []): self`
	`27`	`+ {`
	`28`	`+ @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\Exception::createFromThrowable() instead.', __METHOD__), E_USER_DEPRECATED);`
	`29`	`+`
	`30`	`+ return parent::createFromThrowable($exception, $statusCode, $headers);`
	`31`	`+ }`
`23`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,8 @@ public function render($exception, string $format = 'html'): string`
`62`	`62`	`throw new ErrorRendererNotFoundException(sprintf('No error renderer found for format "%s".', $format));`
`63`	`63`	`}`
`64`	`64`
`65`		`- if ($exception instanceof \Exception) {`
`66`		`- $exception = FlattenException::create($exception);`
	`65`	`+ if ($exception instanceof \Throwable) {`
	`66`	`+ $exception = FlattenException::createFromThrowable($exception);`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`return $this->renderers[$format]->render($exception);`
Original file line number	Diff line number	Diff line change
`@@ -160,8 +160,8 @@ public function handle(\Exception $exception)`
`160`	`160`	`*/`
`161`	`161`	`public function sendPhpResponse($exception)`
`162`	`162`	`{`
`163`		`- if ($exception instanceof \Exception) {`
`164`		`- $exception = FlattenException::create($exception);`
	`163`	`+ if ($exception instanceof \Throwable) {`
	`164`	`+ $exception = FlattenException::createFromThrowable($exception);`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`if (!headers_sent()) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function testInvalidErrorRenderer()`
`27`	`27`	`$container = $this->getMockBuilder('Psr\Container\ContainerInterface')->getMock();`
`28`	`28`	`$container->expects($this->once())->method('has')->with('foo')->willReturn(false);`
`29`	`29`
`30`		`- $exception = FlattenException::create(new \Exception('Foo'));`
	`30`	`+ $exception = FlattenException::createFromThrowable(new \Exception('Foo'));`
`31`	`31`	`(new ErrorRenderer($container))->render($exception, 'foo');`
`32`	`32`	`}`
`33`	`33`
`@@ -48,7 +48,7 @@ public function testCustomErrorRenderer()`
`48`	`48`
`49`	`49`	`$errorRenderer = new ErrorRenderer($container);`
`50`	`50`
`51`		`- $exception = FlattenException::create(new \RuntimeException('Foo'));`
	`51`	`+ $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));`
`52`	`52`	`$this->assertSame('Foo', $errorRenderer->render($exception, 'foo'));`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class ErrorRendererTest extends TestCase`
`24`	`24`	`*/`
`25`	`25`	`public function testErrorRendererNotFound()`
`26`	`26`	`{`
`27`		`- $exception = FlattenException::create(new \Exception('foo'));`
	`27`	`+ $exception = FlattenException::createFromThrowable(new \Exception('foo'));`
`28`	`28`	`(new ErrorRenderer([]))->render($exception, 'foo');`
`29`	`29`	`}`
`30`	`30`
`@@ -34,7 +34,7 @@ public function testErrorRendererNotFound()`
`34`	`34`	`*/`
`35`	`35`	`public function testInvalidErrorRenderer()`
`36`	`36`	`{`
`37`		`- $exception = FlattenException::create(new \Exception('foo'));`
	`37`	`+ $exception = FlattenException::createFromThrowable(new \Exception('foo'));`
`38`	`38`	`(new ErrorRenderer([new \stdClass()]))->render($exception, 'foo');`
`39`	`39`	`}`
`40`	`40`
`@@ -43,7 +43,7 @@ public function testCustomErrorRenderer()`
`43`	`43`	`$renderers = [new FooErrorRenderer()];`
`44`	`44`	`$errorRenderer = new ErrorRenderer($renderers);`
`45`	`45`
`46`		`- $exception = FlattenException::create(new \RuntimeException('Foo'));`
	`46`	`+ $exception = FlattenException::createFromThrowable(new \RuntimeException('Foo'));`
`47`	`47`	`$this->assertSame('Foo', $errorRenderer->render($exception, 'foo'));`
`48`	`48`	`}`
`49`	`49`	`}`