GetResponseForControllerResultEvent
class GetResponseForControllerResultEvent extends GetResponseEvent
Позволяет создать ответ на значение, возвращаемое контроллером.
Вызовите setResponse(), чтобы установить ответ, который будет возвращён для текущего запроса. Распространение этого события останавливается, как только ответ устанавливается.
Методы
| bool | isPropagationStopped() Возвращает, следует ли запускать дальнейшие слушатели событий. | from Event |
| stopPropagation() Останавливает распространение события до дальнейших слушателей событий. | from Event | |
| __construct(HttpKernelInterface $kernel, Request $request, int|null $requestType, $controllerResult) | ||
| HttpKernelInterface | getKernel() Возвращает ядро, в котором было вызвано это событие. | from KernelEvent |
| Request | getRequest() Возвращает запрос, который обрабатывает ядро в настоящее время. | from KernelEvent |
| int | getRequestType() Возвращает тип запроса, который обрабатывает ядро в настоящее время. | from KernelEvent |
| bool | isMasterRequest() Проверяет, является ли это главным запросом. | from KernelEvent |
| Response|null | getResponse() Возвращает объект ответа. | from GetResponseEvent |
| setResponse(Response $response) Устанавливает ответ и останавливает распространение события. | from GetResponseEvent | |
| bool | hasResponse() Возвращает, был ли установлен ответ. | from GetResponseEvent |
| mixed | getControllerResult() Возвращает значение, возвращённое контроллером. | |
| setControllerResult(mixed $controllerResult) Присваивает значение, возвращаемое контроллером. |
Подробное описание
bool isPropagationStopped()
Возвращает, следует ли запускать дальнейшие слушатели событий.
Возвращаемое значение
| bool | Было ли уже остановлено распространение для этого события |
См. также
| Event::stopPropagation |
stopPropagation()
Останавливает распространение события до дальнейших слушателей событий.
Если к одному и тому же событию подключено несколько слушателей событий, ни один дальнейший слушатель событий не будет запущен, как только какой-либо триггер вызовет stopPropagation().
__construct(HttpKernelInterface $kernel, Request $request, int|null $requestType, $controllerResult)
Параметры
| HttpKernelInterface | $kernel | Ядро, в котором было вызвано это событие |
| Request | $request | Запрос, который обрабатывает ядро в настоящее время |
| int|null | $requestType | Тип запроса, который обрабатывает ядро в настоящее время; один из HttpKernelInterface::MASTER_REQUEST или HttpKernelInterface::SUB_REQUEST |
| $controllerResult |
HttpKernelInterface getKernel()
Возвращает ядро, в котором было вызвано это событие.
Возвращаемое значение
| HttpKernelInterface |
Request getRequest()
Возвращает запрос, который обрабатывает ядро в настоящее время.
Возвращаемое значение
| Request |
int getRequestType()
Возвращает тип запроса, который обрабатывает ядро в настоящее время.
Возвращаемое значение
| int | Один из HttpKernelInterface::MASTER_REQUEST и HttpKernelInterface::SUB_REQUEST |
bool isMasterRequest()
Проверяет, является ли это главным запросом.
Возвращаемое значение
| bool | True, если запрос является главным запросом |
Response|null getResponse()
Возвращает объект ответа.
Возвращаемое значение
| Response|null |
setResponse(Response $response)
Устанавливает ответ и останавливает распространение события.
Параметры
| Response | $response |
bool hasResponse()
Возвращает, был ли установлен ответ.
Возвращаемое значение
| bool | Был ли установлен ответ |
mixed getControllerResult()
Возвращает значение, возвращённое контроллером.
Возвращаемое значение
| mixed | Значение, возвращённое контроллером |
setControllerResult(mixed $controllerResult)
Присваивает значение, возвращаемое контроллером.
Параметры
| mixed | $controllerResult | Значение, возвращённое контроллером |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/Event/GetResponseForControllerResultEvent.html