W3cubDocs

/Symfony 4.1

FilterResponseEvent

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
__construct(HttpKernelInterface $kernel, Request $request, int|null $requestType, Response $response)
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
Response getResponse()

Returns the current response object.

setResponse(Response $response)

Sets a new response object.

Details

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

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

Parameters

HttpKernelInterface $kernel The kernel in which this event was thrown
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
Response $response

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

Response getResponse()

Returns the current response object.

Return Value

Response

setResponse(Response $response)

Sets a new response object.

Parameters

Response $response

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/Event/FilterResponseEvent.html