Symfony API
Class

Symfony\Component\HttpKernel\Event\GetResponseEvent

class GetResponseEvent extends KernelEvent

Allows to create a response for a request.

Call setResponse() to set the response that will be returned for the current request. The propagation of this event is stopped as soon as a response is set.

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)

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

from Event
string getName()

Gets the event's name.

from Event
setName(string $name)

Sets the event's name property.

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

from KernelEvent
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 response object.

setResponse(Response $response)

Sets a response and stops event propagation.

bool hasResponse()

Returns whether a response was set.

Details

in Event at line 52
public 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 64
public 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 76
public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

EventDispatcherInterface $dispatcher

in Event at line 88
public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event.

in Event at line 102
public string getName()

Gets the event's name.

Return Value

string

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

Sets the event's name property.

Parameters

string $name The event name.

in KernelEvent at line 47
public __construct(HttpKernelInterface $kernel, Request $request, $requestType)

Parameters

HttpKernelInterface $kernel
Request $request
$requestType

in KernelEvent at line 59
public HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown.

Return Value

HttpKernelInterface

in KernelEvent at line 69
public Request getRequest()

Returns the request the kernel is currently processing.

Return Value

Request

in KernelEvent at line 80
public 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 90
public bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

at line 39
public Response getResponse()

Returns the response object.

Return Value

Response

at line 49
public setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

at line 61
public bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set