Класс RoutingFilter

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

beforeDispatch( Cake\Event\Event $event )

Применяет маршрутизацию и дополнительные параметры к запросу для обработки. Если маршруты не загружены, они будут загружены, и будет выполнена 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

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

Возвращает

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

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

implementedEvents( )

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

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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

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

matches( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

логическое значение

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

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

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

_configRead( string|null $key )

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

Параметры

строка|null $key

Ключ для считывания.

Возвращает

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

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

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

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

Параметры

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

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

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

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

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

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

Исключения

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

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

логическое значение $merge необязательно 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']);

Параметры

string|array $key

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

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

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

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

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

Возвращает

$this

Выбрасывает

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

10