GetResponseEvent
class GetResponseEvent extends KernelEvent
Allows to create a response for a request.
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.
Methods
| bool | isPropagationStopped() Returns whether further event listeners should be triggered. | from Event |
| stopPropagation() Stops the propagation of the event to further event listeners. | from Event | |
| __construct(HttpKernelInterface $kernel, Request $request, $requestType) | from KernelEvent | |
| HttpKernelInterface | getKernel() Returns the kernel in which this event was thrown. | from KernelEvent |
| Request | getRequest() Returns the request the kernel is currently processing. | from KernelEvent |
| int | getRequestType() Returns the request type the kernel is currently processing. | from KernelEvent |
| bool | isMasterRequest() Checks if this is a master request. | from KernelEvent |
| Response | getResponse() Returns the response object. | |
| setResponse(Response $response) Sets a response and stops event propagation. | ||
| bool | hasResponse() Returns whether a response was set. |
Details
bool isPropagationStopped()
Returns whether further event listeners should be triggered.
Return Value
| bool | Whether propagation was already stopped for this event |
See also
| Event::stopPropagation() |
stopPropagation()
Stops the propagation of the event to further event listeners.
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().
__construct(HttpKernelInterface $kernel, Request $request, $requestType)
Parameters
| HttpKernelInterface | $kernel | |
| Request | $request | |
| $requestType |
HttpKernelInterface getKernel()
Returns the kernel in which this event was thrown.
Return Value
| HttpKernelInterface |
Request getRequest()
Returns the request the kernel is currently processing.
Return Value
| Request |
int getRequestType()
Returns the request type the kernel is currently processing.
Return Value
| int | One of HttpKernelInterface::MASTERREQUEST and HttpKernelInterface::SUBREQUEST |
bool isMasterRequest()
Checks if this is a master request.
Return Value
| bool | True if the request is a master request |
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpKernel/Event/GetResponseEvent.html