1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. HttpKernel
  7. \
  8. Event
  9. \
  10. FilterControllerArgumentsEvent

FilterControllerArgumentsEvent

class FilterControllerArgumentsEvent extends FilterControllerEvent

Allows filtering of controller arguments.

You can call getController() to retrieve the controller and getArguments to retrieve the current arguments. With setArguments() you can replace arguments that are used to call the controller.

Arguments set in the event must be compatible with the signature of the controller.

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, array $arguments, Request $request, int|null $requestType)

No description

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.

from FilterControllerEvent
setController(callable $controller)

No description

from FilterControllerEvent
array
getArguments()

No description

setArguments(array $arguments)

No description

Details

bool isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

bool Whether propagation was already stopped for this event

See also

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, array $arguments, Request $request, int|null $requestType)

Parameters

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

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::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST

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

array getArguments()

Return Value

array

setArguments(array $arguments)

Parameters

array $arguments