Класс DispatcherFilter

Этот абстрактный класс представляет собой фильтр, который применяется к циклу диспетчера. Он действует как обработчик событий с возможностью изменения запроса или ответа по мере необходимости перед обработкой контроллером или после того, как тело ответа уже было сгенерировано.

DispatcherFilter реализует CakeEventListener

Прямые подклассы

Абстрактный
Пакет: Cake\Маршрутизация
Авторские права: Авторские права (с) Фонд программного обеспечения Cake, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/Routing/DispatcherFilter.php

Краткое описание свойств

$priority public

integer
Умолчательное значение приоритета для всех методов в этом фильтре
$settings public

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 в свойстве данных.

Возвращаемое значение

смешанный тип
boolean для остановки отправки события или null для продолжения

beforeDispatch()исходный код public

beforeDispatch( CakeEvent $event )

Метод, вызываемый до создания и вызова контроллера для обработки запроса. Если используется приоритет по умолчанию, он будет вызван после того, как маршрутизатор проанализировал URL и установил параметры маршрутизации в объект запроса.

Если возвращается экземпляр объекта CakeResponse, он будет обработан в конце цикла событий, не вызывая контроллера. Это также приведет к тому, что событие after не будет вызвано в диспетчере.

Параметры

CakeEvent $event: объект контейнера, содержащий ключи request, response и additionalParams в свойстве данных.

Возвращаемое значение

CakeResponse|boolean

implementedEvents()исходный код public

implementedEvents( )

Возвращает список событий, на которые подписывается этот фильтр. Диспетчер уведомляет о двух разных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс подключит метод preDispatch и postDispatch соответственно.

Переопределите этот метод, чтобы подписываться только на интересующие вас события.

Возвращаемое значение

массив

Реализация

CakeEventListener::implementedEvents()

Подробное описание свойств

$priorityисходный код

public целое число

Умолчательное значение приоритета для всех методов в этом фильтре

$settingsисходный код

public массив

Настройки для этого фильтра

array()

© 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.
https://api.cakephp.org/2.9/class-DispatcherFilter.html