Класс ControllerFactoryFilter
Фильтр диспетчера, который создаёт контроллер для обработки запроса.
Этот фильтр разрешает параметры запроса в экземпляр контроллера и прикрепляет его к объекту события.
- Cake\Routing\DispatcherFilter implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\Routing\Filter\ControllerFactoryFilter
Краткое описание свойств
-
$_priorityprotectedПриоритет установлен высоким, чтобы позволить вызову других фильтров в первую очередь.integer
Унаследованные свойства
Краткое описание методов
- _getController() protectedПолучает контроллер для использования, плагин или контроллер приложения.
- beforeDispatch() public
Разрешает параметры запроса в контроллер и прикрепляет контроллер к объекту события.
Подробное описание методов
_getController()source protected
_getController( Cake\Network\Request $request , Cake\Network\Response $response )
Получает контроллер для использования, плагин или контроллер приложения.
Параметры
-
Cake\Network\Request$request - Объект запроса
-
Cake\Network\Response$response - Ответ для контроллера.
Возвращает
Cake\Controller\Controller|falseОбъект, если загружен, в противном случае boolean false.
beforeDispatch()source public
beforeDispatch( Cake\Event\Event $event )
Разрешает параметры запроса в контроллер и прикрепляет контроллер к объекту события.
Параметры
-
Cake\Event\Event$event - Экземпляр события.
Переопределяет
Cake\Routing\DispatcherFilter::beforeDispatch() Методы, унаследованные от Cake\Routing\DispatcherFilter
__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 - Экземпляр события.
Возвращает
mixedimplementedEvents()source public
implementedEvents( )
Возвращает список событий, на которые этот фильтр подписывается. Диспетчер уведомляет о 2 разных событиях Dispatcher.before и Dispatcher.after. По умолчанию этот класс соответственно прикрепляет метод preDispatch и postDispatch.
Переопределите этот метод по своему усмотрению, чтобы подписаться только на интересующие события.
Возвращает
массивРеализация
Cake\Event\EventListenerInterface::implementedEvents() matches()source public
matches( Cake\Event\Event $event )
Проверка соответствия входящего запроса критериям этого фильтра.
Параметры
-
Cake\Event\Event$event - Событие для проверки соответствия.
Возвращает
booleanМетоды, унаследованные от Cake\Core\InstanceConfigTrait
_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 - Значение для записи.
- 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 - Ключ для получения/установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.
Возвращает
смешанныйЗначение считываемой конфигурации, или сам объект при операциях записи.
Исключения
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 - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this Сам объект.
Подробное описание свойств
$_prioritysource
protected integer
Приоритет установлен высоким, чтобы позволить вызывать другие фильтры в первую очередь.
50
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.Routing.Filter.ControllerFactoryFilter.html