Класс 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
Когда условия `when` не являются вызываемыми.

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

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

Возвращает

смешанное значение

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

Событие для проверки соответствия.

Возвращает

булево значение

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка или null $key

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

Возвращает

смешанное значение

_configWrite()source protected

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

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

Параметры

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

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

смешанное значение $value

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

булево или строка $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