Класс DispatcherFilter

$filter = new BlogFilter(['for' => '/blog']);

$filter = new BlogFilter(['for' => 'preg:#^/blog/\d+$#']);

$cookieMonster = new CookieFilter([
  'when' => function ($req, $res) {
    // Custom code goes here.
  }
]);

__construct()source public

__construct( array $config [] )

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

Параметры

массив $config необязательно []

Настройки фильтра.

Исключения

InvalidArgumentException
Когда условия 'когда' не вызываемый метод.

afterDispatch()source public

afterDispatch( Cake\Event\Event $event )

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

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

Параметры

Cake\Event\Event $event

объект контейнера, содержащий ключи request и response в свойстве data.

beforeDispatch()source public

beforeDispatch( Cake\Event\Event $event )

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

Если возвращается экземпляр объекта Cake\Network\Response, он будет обработан в конце цикла события, не вызывая контроллер в результате. Это также приведет к тому, что событие «после» в диспетчере не будет вызвано.

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

Параметры

Cake\Event\Event $event

объект контейнера, содержащий ключи request, response и additionalParams в свойстве data.

handle()source public

handle( Cake\Event\Event $event )

Метод обработки, применяющий условия и определяющий метод для вызова.

Параметры

Cake\Event\Event $event

Экземпляр события.

Возвращает

mixed

implementedEvents()source public

implementedEvents( )

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

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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

matches()source public

matches( Cake\Event\Event $event )

Проверяет, соответствует ли входящий запрос критериям этого фильтра.

Параметры

Cake\Event\Event $event

Событие для сопоставления.

Возвращает

boolean

_configDelete()source protected

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записать переменную конфигурации

Параметры

строка|массив $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписать существующую конфигурацию

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всего конфига:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфига одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key необязательно null

Ключ для получения/установки или весь массив настроек.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Флаг рекурсивного слияния или перезаписи существующих настроек, по умолчанию true.

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

mixed
Значение конфига, которое читается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить неверный ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Объединение предоставленного конфига с существующим конфигом. В отличие от config(), которое выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфига одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или весь массив настроек.

mixed|null $value необязательно null

Значение для установки.

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

$this Сам объект.

[
    'when' => null,
    'for' => null,
    'priority' => null,
]

10