W3cubDocs

/Symfony 2.8

Symfony\Component\HttpKernel\Event\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
setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

 from Event
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

 from Event
string getName()

Gets the event's name.

 from Event
setName(string $name)

Sets the event's name property.

 from Event
__construct(HttpKernelInterface $kernel, $controller, Request $request, $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)

Sets a new controller.

Details

public 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()

public 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().

public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

Return Value

EventDispatcherInterface

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

public __construct(HttpKernelInterface $kernel, $controller, Request $request, $requestType)

Parameters

HttpKernelInterface $kernel
$controller
Request $request
$requestType

public HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

public Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

public int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

int One of HttpKernelInterface::MASTERREQUEST and HttpKernelInterface::SUBREQUEST

public bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

public callable getController()

Returns the current controller.

Return Value

callable

public setController(callable $controller)

Sets a new controller.

Parameters

callable $controller

Exceptions

LogicException

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpKernel/Event/FilterControllerEvent.html