class GetResponseForControllerResultEvent extends GetResponseEvent
Allows to create a response for the return value of a controller.
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 | |
| setDispatcher(EventDispatcherInterface $dispatcher) deprecated Stores the EventDispatcher that dispatches this Event. | from Event | |
| EventDispatcherInterface | getDispatcher() deprecated Returns the EventDispatcher that dispatches this Event. | from Event |
| string | getName() deprecated Gets the event's name. | from Event |
| setName(string $name) deprecated Sets the event's name property. | from Event | |
| __construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult) | ||
| 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. | from GetResponseEvent |
| setResponse(Response $response) Sets a response and stops event propagation. | from GetResponseEvent | |
| bool | hasResponse() Returns whether a response was set. | from GetResponseEvent |
| mixed | getControllerResult() Returns the return value of the controller. | |
| setControllerResult(mixed $controllerResult) Assigns the return value of the controller. |
Details
bool isPropagationStopped()
Returns whether further event listeners should be triggered.
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().
setDispatcher(EventDispatcherInterface $dispatcher) deprecated
deprecated
since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.Stores the EventDispatcher that dispatches this Event.
EventDispatcherInterface getDispatcher() deprecated
deprecated
since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.Returns the EventDispatcher that dispatches this Event.
string getName() deprecated
deprecated
since version 2.4, to be removed in 3.0. The event name is passed to the listener call.Gets the event's name.
setName(string $name) deprecated
deprecated
since version 2.4, to be removed in 3.0. The event name is passed to the listener call.Sets the event's name property.
__construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult)
HttpKernelInterface getKernel()
Returns the kernel in which this event was thrown.
Request getRequest()
Returns the request the kernel is currently processing.
int getRequestType()
Returns the request type the kernel is currently processing.
bool isMasterRequest()
Checks if this is a master request.
Response getResponse()
Returns the response object.
setResponse(Response $response)
Sets a response and stops event propagation.
bool hasResponse()
Returns whether a response was set.
mixed getControllerResult()
Returns the return value of the controller.
setControllerResult(mixed $controllerResult)
Assigns the return value of the controller.
Please login to continue.