GetResponseForControllerResultEvent
class GetResponseForControllerResultEvent extends GetResponseEvent
Позволяет создать ответ для возвращаемого значения контроллера.
Вызовите setResponse(), чтобы установить ответ, который будет возвращён для текущего запроса. Распространение этого события останавливается сразу после установки ответа.
Методы
| bool | isPropagationStopped() Возвращает, должны ли быть запущены дальнейшие слушатели событий. | из Event |
| stopPropagation() Останавливает распространение события к дальнейшим слушателям событий. | из Event | |
| setDispatcher(EventDispatcherInterface $dispatcher) устарело Хранит EventDispatcher, который обрабатывает это событие. | из Event | |
| EventDispatcherInterface | getDispatcher() устарело Возвращает EventDispatcher, который обрабатывает это событие. | из Event |
| string | getName() устарело Возвращает имя события. | из Event |
| setName(string $name) устарело Устанавливает свойство имени события. | из Event | |
| __construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult) | ||
| HttpKernelInterface | getKernel() Возвращает ядро, в котором было вызвано это событие. | из KernelEvent |
| Request | getRequest() Возвращает запрос, который в настоящее время обрабатывает ядро. | из KernelEvent |
| int | getRequestType() Возвращает тип запроса, который в настоящее время обрабатывает ядро. | из KernelEvent |
| bool | isMasterRequest() Проверяет, является ли это главным запросом. | из KernelEvent |
| Response | getResponse() Возвращает объект ответа. | из GetResponseEvent |
| setResponse(Response $response) Устанавливает ответ и останавливает распространение события. | из GetResponseEvent | |
| bool | hasResponse() Возвращает, был ли установлен ответ. | из GetResponseEvent |
| mixed | getControllerResult() Возвращает возвращаемое значение контроллера. | |
| setControllerResult(mixed $controllerResult) Присваивает возвращаемое значение контроллера. |
Подробности
bool isPropagationStopped()
Возвращает значение, указывающее, следует ли вызывать дальнейшие обработчики событий.
Значение возврата
| bool | Указывает, была ли остановлена обработка этого события. |
См. также
| Event::stopPropagation() |
stopPropagation()
Останавливает распространение события к дальнейшим обработчикам событий.
Если к одному и тому же событию подключено несколько обработчиков, никакой дальнейший обработчик не будет вызван после того, как любой обработчик вызовет stopPropagation().
setDispatcher(EventDispatcherInterface $dispatcher) устарело
устарело
Хранит EventDispatcher, который обрабатывает это событие.
Параметры
| EventDispatcherInterface | $dispatcher |
EventDispatcherInterface getDispatcher() устарело
устарело
Возвращает EventDispatcher, который обрабатывает это событие.
Значение возврата
| EventDispatcherInterface |
string getName() устарело
устарело
Получает имя события.
Значение возврата
| string |
setName(string $name) устарело
устарело
Устанавливает свойство имени события.
Параметры
| string | $name | Имя события. |
__construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult)
Параметры
| HttpKernelInterface | $kernel | |
| Request | $request | |
| $requestType | ||
| $controllerResult |
HttpKernelInterface getKernel()
Возвращает ядро, в котором было сгенерировано это событие.
Значение возврата
| HttpKernelInterface |
Request getRequest()
Возвращает запрос, который в настоящее время обрабатывает ядро.
Значение возврата
| Request |
int getRequestType()
Возвращает тип запроса, который в настоящее время обрабатывает ядро.
Значение возврата
| int | Один из HttpKernelInterface::MASTER_REQUEST и HttpKernelInterface::SUB_REQUEST |
bool isMasterRequest()
Проверяет, является ли это основным запросом.
Значение возврата
| bool | True, если запрос является основным |
Response getResponse()
Возвращает объект ответа.
Значение возврата
| Response |
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.
http://api.symfony.com/3.0/Symfony/Component/HttpKernel/Event/GetResponseForControllerResultEvent.html
