Spec-Zone.ru › CakePHP 3.3

Класс Dispatcher

Dispatcher преобразует запросы в действия контроллера. Он использует обработанный запрос для поиска и загрузки правильного контроллера. Если найден, запрашиваемое действие вызывается на контроллере

Cake\Routing\Dispatcher использует Cake\Event\EventDispatcherTrait
Пространство имён: Cake\Routing
Расположение: Routing/Dispatcher.php

Краткое описание свойств

  • $_filters protected
    array
    Объекты подключенных фильтров

Наследуемые свойства

  • _eventClass, _eventManager

Краткое описание методов

  • addFilter() public
    Добавить фильтр в этот диспетчер.
  • dispatch() public

    Обрабатывает и вызывает заданный запрос, передавая управление вовлечённому контроллеру. Если контроллеру установлено автоматическое отображение через Controller::$autoRender, Dispatcher отобразит представление.

  • filters() public
    Получить список подключенных фильтров.

Подробное описание методов

addFilter()source public

addFilter( Cake\Event\EventListenerInterface $filter )

Добавить фильтр в этот диспетчер.

Добавленный фильтр будет прикреплён к менеджеру событий, используемому этим диспетчером.

Параметры

Cake\Event\EventListenerInterface $filter

Фильтр для подключения. Может быть любым EventListenerInterface. Обычно экземпляр \Cake\Routing\DispatcherFilter.

dispatch()source public

dispatch( Cake\Network\Request $request , Cake\Network\Response $response )

Обрабатывает и вызывает заданный запрос, передавая управление вовлечённому контроллеру. Если контроллеру установлено автоматическое отображение через Controller::$autoRender, Dispatcher отобразит представление.

Действия в CakePHP могут быть любым публичным методом контроллера, который не объявлен в Controller. Если вы хотите, чтобы методы контроллера были публичными и недоступными по URL, добавьте к ним префикс _. Например, public function _loadPosts() { } будет недоступен по URL. Частные и защищенные методы также недоступны по URL.

Если контроллер с заданным именем не найден, invoke() выбросит исключение. Если контроллер найден, а действие не найдено, будет выброшено исключение.

Параметры

Cake\Network\Request $request
Объект запроса для обработки.
Cake\Network\Response $response
Объект ответа для размещения результатов обработки.

Возвращает

string|null
если $request['return'] установлено, возвращает тело ответа, в противном случае null

Исключение

LogicException
Когда контроллер не был создан в событии Dispatcher.beforeDispatch.

filters()source public

filters( )

Получить список подключенных фильтров.

Возвращает

array

Методы, используемые из Cake\Event\EventDispatcherTrait

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обёртка для создания и обработки событий.

Возвращает обработанное событие.

Параметры

строка $name
Имя события.
массив|null $data опционально null

Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.

объект|null $subject опционально null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера событий Cake\Event\EventManager для этого объекта.

Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов для событий объекта, или создавать свои собственные события и вызывать их по желанию.

Параметры

Cake\Event\EventManager $eventManager опционально null
менеджер событий для установки

Возвращает

Cake\Event\EventManager

Подробное описание свойств

$_filterssource

protected массив

Объекты подключенных фильтров

[]

© 2005–2017 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.
https://api.cakephp.org/3.3/class-Cake.Routing.Dispatcher.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API