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