GetResponseForControllerResultEvent
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.
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().
setDispatcher(EventDispatcherInterface $dispatcher) deprecated
deprecated
Stores the EventDispatcher that dispatches this Event.
Parameters
| EventDispatcherInterface | $dispatcher |
EventDispatcherInterface getDispatcher() deprecated
deprecated
Returns the EventDispatcher that dispatches this Event.
Return Value
| EventDispatcherInterface |
string getName() deprecated
deprecated
Gets the event's name.
Return Value
| string |
setName(string $name) deprecated
deprecated
Sets the event's name property.
Parameters
| string | $name | The event name. |
__construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult)
Parameters
| HttpKernelInterface | $kernel | |
| Request | $request | |
| $requestType | ||
| $controllerResult |
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 |
mixed getControllerResult()
Returns the return value of the controller.
Return Value
| mixed | The controller return value |
setControllerResult(mixed $controllerResult)
Assigns the return value of the controller.
Parameters
| mixed | $controllerResult | The controller return value |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpKernel/Event/GetResponseForControllerResultEvent.html