Класс DispatcherFilter
Этот абстрактный класс представляет собой фильтр, применяемый к циклу диспетчера. Он действует как обработчик событий с возможностью изменения запроса или ответа по мере необходимости до обработки контроллером или после построения тела ответа.
- DispatcherFilter реализует CakeEventListener
Прямые подклассы
Пакет: Cake\Маршрутизация
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Routing/DispatcherFilter.php
Краткое описание свойств
-
$prioritypublicУмолчательный приоритет для всех методов в этом фильтреinteger -
$settingspublicНастройки для этого фильтраarray
Краткое описание методов
- __construct() publicКонструктор.
- afterDispatch() public
Метод, вызываемый после того, как контроллер обработает запрос и сгенерирует ответ. В этот момент можно изменить объект ответа, так как он еще не отправлен клиенту.
- beforeDispatch() public
Метод, вызываемый перед созданием и вызовом контроллера для обработки запроса. Если используется приоритет по умолчанию, он будет вызван после того, как маршрутизатор обработает URL и установит параметры маршрутизации в объект запроса.
- implementedEvents() public
Возвращает список событий, на которые подписывается этот фильтр. Диспетчер уведомляет о двух разных событиях
Dispatcher.beforeиDispatcher.after. По умолчанию этот класс будет подписываться на методыpreDispatchиpostDispatchсоответственно.
Подробное описание методов
__construct()исходный код public
__construct( array $settings array() )
Конструктор.
Параметры
- массив
$settingsнеобязательно массив() - Настройки конфигурации фильтра.
afterDispatch()исходный код public
afterDispatch( CakeEvent $event )
Метод, вызываемый после того, как контроллер обработает запрос и сгенерирует ответ. В этот момент можно изменить объект ответа, так как он еще не отправлен клиенту.
Если возвращается false, событие будет остановлено, и больше никаких обработчиков не будут уведомлены. В качестве альтернативы можно вызвать $event->stopPropagation(), чтобы достичь того же результата.
Параметры
-
CakeEvent$event объект контейнера, содержащий ключи
requestиresponseв свойстве data.
Возвращаемое значение
смешанный типлогическое значение для остановки отправки события или null для продолжения
beforeDispatch()исходный код public
beforeDispatch( CakeEvent $event )
Метод, вызываемый перед созданием и вызовом контроллера для обработки запроса. Если используется приоритет по умолчанию, он будет вызван после того, как маршрутизатор обработает URL и установит параметры маршрутизации в объект запроса.
Если возвращается экземпляр объекта CakeResponse, он будет обработан в конце цикла события, не вызывая никакого контроллера в результате. Это также повлияет на то, что событие после не будет вызываться в диспетчере.
Если возвращается false, событие будет остановлено, и больше никаких обработчиков не будут уведомлены. В качестве альтернативы можно вызвать $event->stopPropagation() для достижения того же результата.
Параметры
-
CakeEvent$event объект контейнера, содержащий ключи
request,responseиadditionalParamsв свойстве data.
Возвращаемое значение
CakeResponse|логическое значениеimplementedEvents()исходный код public
implementedEvents( )
Возвращает список событий, на которые подписывается этот фильтр. Диспетчер уведомляет о двух разных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс будет подписываться на методы preDispatch и postDispatch соответственно.
Переопределите этот метод по своему усмотрению, чтобы подписываться только на интересующие вас события.
Возвращаемое значение
массивРеализация
CakeEventListener::implementedEvents() Подробное описание свойств
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.8/class-DispatcherFilter.html