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
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

Stores the EventDispatcher that dispatches this Event.

from Event
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, $controller, Request $request, int $requestType)

No description

getKernel()

Returns the kernel in which this event was thrown.

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.

callable
getController()

Returns the current controller.

setController(callable $controller)

Sets a new controller.

Details

in Event at line 52
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

in Event at line 64
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().

in Event at line 76
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.

Parameters

EventDispatcherInterface $dispatcher

in Event at line 88
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.

in Event at line 102
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.

Return Value

string

in Event at line 116
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.

Parameters

string $name The event name

at line 32
__construct(HttpKernelInterface $kernel, $controller, Request $request, int $requestType)

Parameters

HttpKernelInterface $kernel The kernel in which this event was thrown
$controller
Request $request The request the kernel is currently processing
int $requestType The request type the kernel is currently processing; one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST

in KernelEvent at line 47
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line 57
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line 68
int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

int One of HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST

in KernelEvent at line 78
bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

at line 44
callable getController()

Returns the current controller.

Return Value

callable

at line 56
setController(callable $controller)

Sets a new controller.

Parameters

callable $controller

Exceptions

LogicException