Spec-Zone.ru › CakePHP 2.7

Класс DispatcherFilter

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

DispatcherFilter реализует CakeEventListener

Непосредственные известные подклассы

AssetDispatcher, CacheDispatcher
Абстрактный
Пакет: Cake\Routing
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Routing/DispatcherFilter.php

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

__constructисходный код public

__construct( array $settings array() )

Конструктор.

Параметры

массив $settings необязательный array()
Параметры конфигурации для фильтра.

afterDispatchисходный код public

afterDispatch( CakeEvent $event )

Метод, вызываемый после того, как контроллер обработает запрос и сгенерирует ответ. В этот момент можно изменить объект ответа, так как он еще не отправлен клиенту.

Если возвращается false, событие будет остановлено, и больше никакие слушатели не будут уведомлены. В качестве альтернативы, вы можете вызвать $event->stopPropagation() для достижения такого же результата.

Параметры

CakeEvent $event
объект контейнера, имеющий ключи request и response в свойстве data.

Возвращает

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

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

beforeDispatch( CakeEvent $event )

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

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

Если возвращается false, событие будет остановлено, и больше никакие слушатели не будут уведомлены. В качестве альтернативы, вы можете вызвать $event->stopPropagation() для достижения такого же результата.

Параметры

CakeEvent $event
объект контейнера, имеющий ключи request, response и additionalParams в свойстве data.

Возвращает

CakeResponse|boolean
CakeResponse|bool

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

implementedEvents( )

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

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

Возвращает

array
массив

Реализация

CakeEventListener::implementedEvents()

Резюме свойств

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

public целое число

Приоритет по умолчанию для всех методов в этом фильтре

10

$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.
http://api.cakephp.org/2.7/class-DispatcherFilter.html

Spec-Zone.ru

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