class FilterResponseEvent extends KernelEvent

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.

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) deprecated

Stores the EventDispatcher that dispatches this Event.

from Event
getDispatcher() deprecated

Returns the EventDispatcher that dispatches this Event.

from Event
string
getName() deprecated

Gets the event's name.

from Event
setName(string $name) deprecated

Sets the event's name property.

from Event
__construct(HttpKernelInterface $kernel, Request $request, $requestType, Response $response)

No description

getKernel()

Returns the kernel in which this event was thrown.

getRequest()

Returns the request the kernel is currently processing.

int
getRequestType()

Returns the request type the kernel is currently processing.

bool
isMasterRequest()

Checks if this is a master request.

getResponse()

Returns the current response object.

setResponse(Response $response)

Sets a new response object.

Details

in Event at line line 52
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()

in Event at line line 64
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().

in Event at line line 76
setDispatcher(EventDispatcherInterface $dispatcher) deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

in Event at line line 88
EventDispatcherInterface getDispatcher() deprecated

deprecated since version 2.4, to be removed in 3.0. The event dispatcher is passed to the listener call.

Returns the EventDispatcher that dispatches this Event.

in Event at line line 102
string getName() deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Gets the event's name.

Return Value

string

in Event at line line 116
setName(string $name) deprecated

deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.

Sets the event's name property.

Parameters

string $name The event name.

at line line 36
__construct(HttpKernelInterface $kernel, Request $request, $requestType, Response $response)

Parameters

HttpKernelInterface $kernel
Request $request
$requestType
Response $response

in KernelEvent at line line 59
HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line line 69
Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line line 80
int getRequestType()

Returns the request type the kernel is currently processing.

Return Value

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

in KernelEvent at line line 90
bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

at line line 48
Response getResponse()

Returns the current response object.

Return Value

Response

at line line 58
setResponse(Response $response)

Sets a new response object.

Parameters

Response $response