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

Stores the EventDispatcher that dispatches this Event.

from Event
EventDispatcherInterface 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) 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

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

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

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.

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

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.

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

Parameters

HttpKernelInterface $kernel
Request $request
$requestType

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::MASTERREQUEST and HttpKernelInterface::SUBREQUEST

bool isMasterRequest()

Checks if this is a master request.

Return Value

bool True if the request is a master request

Response getResponse()

Returns the response object.

Return Value

Response

setResponse(Response $response)

Sets a response and stops event propagation.

Parameters

Response $response

bool hasResponse()

Returns whether a response was set.

Return Value

bool Whether a response was set
doc_Symfony
2016-10-28 06:19:47
Comments
Leave a Comment

Please login to continue.