minor #12749 Document: get/setThrowable (OskarStark)

OskarStark · OskarStark · commit 7ef72fe8eee6 · 2019-12-03T13:25:37.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- Document: get/setThrowable Fixes #12615 Fixes #12716 Commits ------- 37a5f1e get/setThrowable
diff --git a/components/http_kernel.rst b/components/http_kernel.rst
@@ -526,10 +526,22 @@ to the exception.
 
 Each listener to this event is passed a :class:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent`
 object, which you can use to access the original exception via the
-:method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::getException`
+:method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::getThrowable`
 method. A typical listener on this event will check for a certain type of
 exception and create an appropriate error ``Response``.
 
+.. versionadded:: 4.4
+
+    The :method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::getThrowable` and
+    :method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::setThrowable` methods
+    were introduced in Symfony 4.4.
+
+.. deprecated:: 4.4
+
+    The :method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::getException` and
+    :method:`Symfony\\Component\\HttpKernel\\Event\\ExceptionEvent::setException` methods
+    are deprecated since Symfony 4.4.
+
 For example, to generate a 404 page, you might throw a special type of exception
 and then add a listener on this event that looks for this exception and
 creates and returns a 404 ``Response``. In fact, the HttpKernel component
diff --git a/event_dispatcher.rst b/event_dispatcher.rst
@@ -35,7 +35,7 @@ The most common way to listen to an event is to register an **event listener**::
         public function onKernelException(ExceptionEvent $event)
         {
             // You get the exception object from the received event
-            $exception = $event->getException();
+            $exception = $event->getThrowable();
             $message = sprintf(
                 'My Error says: %s with code: %s',
                 $exception->getMessage(),
diff --git a/reference/events.rst b/reference/events.rst
@@ -239,14 +239,14 @@ sent as response::
 
     public function onKernelException(ExceptionEvent $event)
     {
-        $exception = $event->getException();
+        $exception = $event->getThrowable();
         $response = new Response();
         // setup the Response object based on the caught exception
         $event->setResponse($response);
 
         // you can alternatively set a new Exception
         // $exception = new \Exception('Some special exception');
-        // $event->setException($exception);
+        // $event->setThrowable($exception);
     }
 
 .. note::

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ The most common way to listen to an event is to register an event listener::`
`35`	`35`	`public function onKernelException(ExceptionEvent $event)`
`36`	`36`	`{`
`37`	`37`	`D26F // You get the exception object from the received event`
`38`		`- $exception = $event->getException();`
	`38`	`+ $exception = $event->getThrowable();`
`39`	`39`	`$message = sprintf(`
`40`	`40`	`'My Error says: %s with code: %s',`
`41`	`41`	`$exception->getMessage(),`
Original file line number	Diff line number	Diff line change
`@@ -239,14 +239,14 @@ sent as response::`
`239`	`239`
`240`	`240`	`public function onKernelException(ExceptionEvent $event)`
`241`	`241`	`{`
`242`		`- $exception = $event->getException();`
	`242`	`+ $exception = $event->getThrowable();`
`243`	`243`	`$response = new Response();`
`244`	`244`	`// setup the Response object based on the caught exception`
`245`	`245`	`$event->setResponse($response);`
`246`	`246`
`247`	`247`	`// you can alternatively set a new Exception`
`248`	`248`	`// $exception = new \Exception('Some special exception');`
`249`		`- // $event->setException($exception);`
	`249`	`+ // $event->setThrowable($exception);`
`250`	`250`	`}`
`251`	`251`
`252`	`252`	`.. note::`