Класс LocaleSelectorFilter

__constructsource public

__construct( array $config [] )

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

Параметры

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

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

Исключения

Cake\Core\Exception\Exception
Когда условия «when» не вызываемы.

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

Cake\Routing\DispatcherFilter::__construct()

beforeDispatchsource public

beforeDispatch( Cake\Event\Event $event )

Проверяет запрос на наличие заголовка Accept-Language и устанавливает локаль для текущего выполнения, если она соответствует списку допустимых локалей, переданных в конфигурации.

Параметры

Cake\Event\Event $event

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

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

Cake\Routing\DispatcherFilter::beforeDispatch()

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( )

Возвращает список событий, за которыми следит этот фильтр. Диспечер уведомляет о двух разных событиях 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
Сам объект $this.

[]

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

10

[]

false