Spec-Zone.ru › CakePHP 2.8

Класс DispatcherFilter

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

DispatcherFilter реализует CakeEventListener

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

  • AssetDispatcher
  • CacheDispatcher
Абстрактный
Пакет: Cake\Маршрутизация
Авторские права: Copyright (c) Cake Software Foundation, 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 в свойстве 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()

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

$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.8/class-DispatcherFilter.html

Spec-Zone.ru

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