Класс RoutingFilter

beforeDispatchsource public

beforeDispatch( Cake\Event\Event $event )

Применяет маршрутизацию и дополнительные параметры к запросу, который будет обработан. Если маршруты ещё не загружены, они будут загружены, и будет выполнен файл config/routes.php.

Параметры

Cake\Event\Event $event

содержащий запрос, ответ и дополнительные параметры

Переопределяет

Cake\Routing\DispatcherFilter::beforeDispatch()

__constructsource public

__construct( array $config [] )

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

Параметры

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

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

Исключения

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

afterDispatchsource public

afterDispatch( Cake\Event\Event $event )

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

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

Параметры

Cake\Event\Event $event

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

handlesource public

handle( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

mixed
смешанный тип

implementedEventssource public

implementedEvents( )

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

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

Возвращает

array
массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

matchessource public

matches( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

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

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

Возвращает

mixed
смешанный тип

_configWritesource protected

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

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

Параметры

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

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

смешанный тип $value

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

булево значение или строка $merge необязательно false

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

Исключения

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

configsource 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']);

Параметры

строка, массив или null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный тип или null $value необязательно null

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

булево значение $merge необязательно true

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

Возвращает

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

Исключения

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

configShallowsource 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']);

Параметры

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

Ключ для установки или полный массив конфигураций.

смешанный тип или null $value необязательно null

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

Возвращает

mixed
Сам объект.

10

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

[]

false