Documentation

FilterResponseEvent extends KernelEvent
in package

Allows to filter a Response object.

You can call getResponse() to retrieve the current response. With setResponse() you can set a new response that will be returned to the browser.

Tags
author

Bernhard Schussek bschussek@gmail.com

Table of Contents

$kernel  : mixed
$propagationStopped  : bool
$request  : mixed
$requestType  : mixed
$response  : mixed
__construct()  : mixed
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.
getResponse()  : Response
Returns the current response object.
isMasterRequest()  : bool
Checks if this is a master request.
isPropagationStopped()  : bool
Returns whether further event listeners should be triggered.
setResponse()  : mixed
Sets a new response object.
stopPropagation()  : mixed
Stops the propagation of the event to further event listeners.

Properties

$propagationStopped

private bool $propagationStopped = false

Whether no further event listeners should be triggered

Methods

__construct()

public __construct(HttpKernelInterface $kernel, Request $request, mixed $requestType, Response $response) : mixed
Parameters
$kernel : HttpKernelInterface

The kernel in which this event was thrown

$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

$response : Response
Return values
mixed —

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
see
Event::stopPropagation()
Return values
bool —

Whether propagation was already stopped for this event

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

Return values
mixed —

Search results