GetResponseEvent
extends KernelEvent
in package
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.
Tags
Table of Contents
- $kernel : mixed
- $propagationStopped : bool
- $request : mixed
- $requestType : mixed
- $response : mixed
- __construct() : mixed
- getKernel() : HttpKernelInterface
- Returns the kernel in which this event was thrown.
- getRequest() : Request
- Returns the request the kernel is currently processing.
- getRequestType() : int
- Returns the request type the kernel is currently processing.
- getResponse() : Response|null
- Returns the response object.
- hasResponse() : bool
- Returns whether a response was set.
- isMasterRequest() : bool
- Checks if this is a master request.
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- setResponse() : mixed
- Sets a response and stops event propagation.
- stopPropagation() : mixed
- Stops the propagation of the event to further event listeners.
Properties
$kernel
private
mixed
$kernel
$propagationStopped
private
bool
$propagationStopped
= false
Whether no further event listeners should be triggered
$request
private
mixed
$request
$requestType
private
mixed
$requestType
$response
private
mixed
$response
Methods
__construct()
public
__construct(HttpKernelInterface $kernel, Request $request, int $requestType) : mixed
Parameters
- $kernel : HttpKernelInterface
-
The kernel in which this event was thrown
- $request : Request
-
The request the kernel is currently processing
- $requestType : int
-
The request type the kernel is currently processing; one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST
Return values
mixed —getKernel()
Returns the kernel in which this event was thrown.
public
getKernel() : HttpKernelInterface
Return values
HttpKernelInterface —getRequest()
Returns the request the kernel is currently processing.
public
getRequest() : Request
Return values
Request —getRequestType()
Returns the request type the kernel is currently processing.
public
getRequestType() : int
Return values
int —One of HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST
getResponse()
Returns the response object.
public
getResponse() : Response|null
Return values
Response|null —hasResponse()
Returns whether a response was set.
public
hasResponse() : bool
Return values
bool —Whether a response was set
isMasterRequest()
Checks if this is a master request.
public
isMasterRequest() : bool
Return values
bool —True if the request is a master request
isPropagationStopped()
Returns whether further event listeners should be triggered.
public
isPropagationStopped() : bool
Tags
Return values
bool —Whether propagation was already stopped for this event
setResponse()
Sets a response and stops event propagation.
public
setResponse(Response $response) : mixed
Parameters
- $response : Response
Return values
mixed —stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : mixed
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().