W3cubDocs

/Symfony 2.7

Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent

class GetResponseForControllerResultEvent extends GetResponseEvent

Allows to create a response for the return value of a controller

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

Boolean 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, $controllerResult)
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
integer getRequestType()

Returns the request type the kernel is currently processing

from KernelEvent
Response getResponse()

Returns the response object

from GetResponseEvent
setResponse(Response $response)

Sets a response and stops event propagation

from GetResponseEvent
Boolean hasResponse()

Returns whether a response was set

from GetResponseEvent
mixed getControllerResult()

Returns the return value of the controller.

setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Details

public Boolean isPropagationStopped()

Returns whether further event listeners should be triggered.

Return Value

Boolean Whether propagation was already stopped for this event.

See also

Event::stopPropagation

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

public setDispatcher(EventDispatcherInterface $dispatcher)

Stores the EventDispatcher that dispatches this Event

Parameters

EventDispatcherInterface $dispatcher

public EventDispatcherInterface getDispatcher()

Returns the EventDispatcher that dispatches this Event

public string getName()

Gets the event's name.

Return Value

string

public setName(string $name)

Sets the event's name property.

Parameters

string $name The event name.

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

Parameters

HttpKernelInterface $kernel
Request $request
$requestType
$controllerResult

public HttpKernelInterface getKernel()

Returns the kernel in which this event was thrown

Return Value

HttpKernelInterface

public Request getRequest()

Returns the request the kernel is currently processing

Return Value

Request

public integer getRequestType()

Returns the request type the kernel is currently processing

Return Value

integer One of HttpKernelInterface::MASTERREQUEST and HttpKernelInterface::SUBREQUEST

public Response getResponse()

Returns the response object

Return Value

Response

public setResponse(Response $response)

Sets a response and stops event propagation

Parameters

Response $response

public Boolean hasResponse()

Returns whether a response was set

Return Value

Boolean Whether a response was set

public mixed getControllerResult()

Returns the return value of the controller.

Return Value

mixed The controller return value

public setControllerResult(mixed $controllerResult)

Assigns the return value of the controller.

Parameters

mixed $controllerResult The controller return value