Класс RoutingFilter

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

beforeDispatch( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

Cake\Http\Response|null
Ответ будет возвращен при обнаружении маршрута перенаправления.

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

Cake\Routing\DispatcherFilter::beforeDispatch()

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

__construct( array $config = [] )

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

Параметры

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

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

Исключения

InvalidArgumentException
Если условия 'when' не вызываемый.

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

afterDispatch( Cake\Event\Event $event )

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

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

Параметры

Cake\Event\Event $event

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

handle()исходный код public

handle( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

mixed

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

implementedEvents( )

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

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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

matches()исходный код public

matches( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

boolean

_configDelete()исходный код protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()исходный код protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

строка|null $key

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

Возвращает

mixed

_configWrite()исходный код protected

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

Записывает ключ конфигурации.

Параметры

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

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

смешанный $value

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

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

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

Исключения

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

config()исходный код public deprecated

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

Устарело

3.4.0 использовать setConfig()/getConfig() вместо этого.

Параметры

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

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

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

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

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

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

Возвращает

смешанный
Считываемое значение конфигурации или сам объект при операциях записи.

Исключения

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

configShallow()исходный код public

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()исходный код public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

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

Чтение всей конфигурации:

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key необязательно null

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

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

Значение по умолчанию, возвращаемое, если ключ не существует.

Возвращает

смешанный
Считываемое значение конфигурации.

setConfig()source public

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

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

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

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

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

логическое $merge необязательно true

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

Возвращает

$this

Выбрасывает

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

10