Spec-Zone.ru › Symfony 3.2

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

deprecated

since версия 2.4, будет удалена в 3.0. Диспетчер событий передаётся в вызов обработчика.

Хранит EventDispatcher, который обрабатывает это событие.

Параметры

EventDispatcherInterface $dispatcher

EventDispatcherInterface getDispatcher() deprecated

deprecated

since версия 2.4, будет удалена в 3.0. Диспетчер событий передаётся в вызов обработчика.

Возвращает EventDispatcher, который обрабатывает это событие.

Значение возврата

EventDispatcherInterface

string getName() deprecated

deprecated

since версия 2.4, будет удалена в 3.0. Имя события передаётся в вызов обработчика.

Возвращает имя события.

Значение возврата

string

setName(string $name) deprecated

deprecated

since версия 2.4, будет удалена в 3.0. Имя события передаётся в вызов обработчика.

Устанавливает свойство имени события.

Параметры

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.2/Symfony/Component/HttpKernel/Event/GetResponseForControllerResultEvent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API