GetResponseForExceptionEvent
class GetResponseForExceptionEvent extends GetResponseEvent
Allows to create a response for a thrown exception.
Call setResponse() to set the response that will be returned for the current request. The propagation of this event is stopped as soon as a response is set.
You can also call setException() to replace the thrown exception. This exception will be thrown if no response is set during processing of this event.
Methods
| Response | getResponse() Returns the response object. | from GetResponseEvent |
| setResponse(Response $response) Sets a response and stops event propagation. | from GetResponseEvent | |
| bool | hasResponse() Returns whether a response was set. | from GetResponseEvent |
| __construct(HttpKernelInterface $kernel, Request $request, int $requestType, Exception $e) | ||
| Exception | getException() Returns the thrown exception. | |
| setException(Exception $exception) Replaces the thrown exception. | ||
| allowCustomResponseCode() Mark the event as allowing a custom response code. | ||
| bool | isAllowingCustomResponseCode() Returns true if the event allows a custom response code. |
Details
Response getResponse()
Returns the response object.
Return Value
| Response |
setResponse(Response $response)
Sets a response and stops event propagation.
Parameters
| Response | $response |
bool hasResponse()
Returns whether a response was set.
Return Value
| bool | Whether a response was set |
__construct(HttpKernelInterface $kernel, Request $request, int $requestType, Exception $e)
Parameters
| HttpKernelInterface | $kernel | |
| Request | $request | |
| int | $requestType | |
| Exception | $e |
Exception getException()
Returns the thrown exception.
Return Value
| Exception | The thrown exception |
setException(Exception $exception)
Replaces the thrown exception.
This exception will be thrown if no response is set in the event.
Parameters
| Exception | $exception | The thrown exception |
allowCustomResponseCode()
Mark the event as allowing a custom response code.
bool isAllowingCustomResponseCode()
Returns true if the event allows a custom response code.
Return Value
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpKernel/Event/GetResponseForExceptionEvent.html