FilterControllerEvent
class FilterControllerEvent extends KernelEvent
Allows filtering of a controller callable.
You can call getController() to retrieve the current controller. With setController() you can set a new controller that is used in the processing of the request.
Controllers should be callables.
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, callable $controller, Request $request, int $requestType) | ||
| 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 |
| callable | getController() Returns the current controller. | |
| setController(callable $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().
__construct(HttpKernelInterface $kernel, callable $controller, Request $request, int $requestType)
Parameters
| HttpKernelInterface | $kernel | The kernel in which this event was thrown |
| callable | $controller | |
| Request | $request | The request the kernel is currently processing |
| int | $requestType | The request type the kernel is currently processing; one of HttpKernelInterface::MASTERREQUEST or HttpKernelInterface::SUBREQUEST |
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 |
callable getController()
Returns the current controller.
Return Value
| callable |
setController(callable $controller)
Parameters
| callable | $controller |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpKernel/Event/FilterControllerEvent.html