Класс ControllerFactoryFilter

_getController()source protected

_getController( Cake\Http\ServerRequest $request , Cake\Http\Response $response )

Получает контроллер для использования, либо плагин, либо контроллер приложения.

Параметры

Cake\Http\ServerRequest $request

Объект запроса

Cake\Http\Response $response

Ответ для контроллера.

Возвращает

Cake\Controller\Controller

Выбрасывает

ReflectionException

beforeDispatch()source public

beforeDispatch( Cake\Event\Event $event )

Разрешает параметры запроса в контроллер и прикрепляет контроллер к объекту события.

Параметры

Cake\Event\Event $event

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

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

Cake\Routing\DispatcherFilter::beforeDispatch()

__construct()source public

__construct( array $config = [] )

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

Параметры

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

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

Выбрасывает

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

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

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

смешанное $value

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

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

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

Выбрасывает

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

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

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

Возвращает

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

Выбрасывает

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

configShallow()source 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()source 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');

Параметры

string|null $key необязательно null

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

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

Возвращаемое значение, если ключ не найден.

Возвращает

mixed
Значение конфигурации.

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
При попытке установить недопустимый ключ.

50