FilterControllerArgumentsEvent
extends FilterControllerEvent
in package
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.
Tags
Table of Contents
- $arguments : mixed
- $controller : mixed
- $kernel : mixed
- $propagationStopped : bool
- $request : mixed
- $requestType : mixed
- __construct() : mixed
- getArguments() : array<string|int, mixed>
- getController() : callable
- Returns the current controller.
- getKernel() : HttpKernelInterface
- Returns the kernel in which this event was thrown.
- getRequest() : Request
- Returns the request the kernel is currently processing.
- getRequestType() : int
- Returns the request type the kernel is currently processing.
- isMasterRequest() : bool
- Checks if this is a master request.
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- setArguments() : mixed
- setController() : mixed
- stopPropagation() : mixed
- Stops the propagation of the event to further event listeners.
Properties
$arguments
private
mixed
$arguments
$controller
private
mixed
$controller
$kernel
private
mixed
$kernel
$propagationStopped
private
bool
$propagationStopped
= false
Whether no further event listeners should be triggered
$request
private
mixed
$request
$requestType
private
mixed
$requestType
Methods
__construct()
public
__construct(HttpKernelInterface $kernel, callable $controller, array<string|int, mixed> $arguments, Request $request, mixed $requestType) : mixed
Parameters
- $kernel : HttpKernelInterface
-
The kernel in which this event was thrown
- $controller : callable
- $arguments : array<string|int, mixed>
- $request : Request
-
The request the kernel is currently processing
- $requestType : mixed
-
The request type the kernel is currently processing; one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST
Return values
mixed —getArguments()
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getController()
Returns the current controller.
public
getController() : callable
Return values
callable —getKernel()
Returns the kernel in which this event was thrown.
public
getKernel() : HttpKernelInterface
Return values
HttpKernelInterface —getRequest()
Returns the request the kernel is currently processing.
public
getRequest() : Request
Return values
Request —getRequestType()
Returns the request type the kernel is currently processing.
public
getRequestType() : int
Return values
int —One of HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST
isMasterRequest()
Checks if this is a master request.
public
isMasterRequest() : bool
Return values
bool —True if the request is a master request
isPropagationStopped()
Returns whether further event listeners should be triggered.
public
isPropagationStopped() : bool
Tags
Return values
bool —Whether propagation was already stopped for this event
setArguments()
public
setArguments(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
Return values
mixed —setController()
public
setController(callable $controller) : mixed
Parameters
- $controller : callable
Return values
mixed —stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : mixed
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().