Класс LocaleSelectorFilter

__construct()source public

__construct( array $config [] )

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

Параметры

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

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

Исключения

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

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

Cake\Routing\DispatcherFilter::__construct()

beforeDispatch()source public

beforeDispatch( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

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

Cake\Routing\DispatcherFilter::beforeDispatch()

afterDispatch()source public

afterDispatch( Cake\Event\Event $event )

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

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

Параметры

Cake\Event\Event $event

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

handle()source public

handle( Cake\Event\Event $event )

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

Параметры

Cake\Event\Event $event

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

Возвращает

mixed

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

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

Возвращает

boolean

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

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

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

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

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

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

mixed $value

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

boolean или строка $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']);

Параметры

строка, массив или 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']);

Параметры

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

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

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

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

Возвращает

$this Объект самого себя.

[]