ControllerArgumentsEvent
extends KernelEvent
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 : mixed
- $request : mixed
- $requestType : mixed
- __construct() : mixed
- getArguments() : array<string|int, mixed>
- getController() : callable
- 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.
- isMainRequest() : bool
- Checks if this is the main request.
- isMasterRequest() : bool
- Checks if this is a master request.
- isPropagationStopped() : bool
- Is propagation stopped?
- setArguments() : mixed
- setController() : mixed
- stopPropagation() : void
- 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
mixed
$propagationStopped
= false
$request
private
mixed
$request
$requestType
private
mixed
$requestType
Methods
__construct()
public
__construct(HttpKernelInterface $kernel, callable $controller, array<string|int, mixed> $arguments, Request $request, int|null $requestType) : mixed
Parameters
- $kernel : HttpKernelInterface
- $controller : callable
- $arguments : array<string|int, mixed>
- $request : Request
- $requestType : int|null
-
The request type the kernel is currently processing; one of HttpKernelInterface::MAIN_REQUEST or HttpKernelInterface::SUB_REQUEST
Return values
mixed —getArguments()
public
getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getController()
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::MAIN_REQUEST and HttpKernelInterface::SUB_REQUEST
isMainRequest()
Checks if this is the main request.
public
isMainRequest() : bool
Return values
bool —isMasterRequest()
Checks if this is a master request.
public
isMasterRequest() : bool
Tags
Return values
bool —isPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —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() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().