Spec-Zone.ru › CakePHP 2.10

Класс Dispatcher

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

Dispatcher реализует CakeEventListener

Непосредственные подклассы

  • ControllerTestDispatcher
Пакет: Cake\Routing
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Routing/Dispatcher.php

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

  • $_eventManager protected
    CakeEventManager
    Менеджер событий, используемый для обработки фильтров диспетчера

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

  • __construct() public
    Конструктор.
  • _attachFilters() protected

    Прикрепляет все обработчики событий для этого экземпляра диспетчера. Загружает фильтры диспетчера из заданных мест.

  • _getController() protected
    Получение контроллера для использования: контроллер плагина или контроллер приложения
  • _invoke() protected

    Инициализирует компоненты и модели, которые будет использовать контроллер. Вызывает действие контроллера и вызывает отображение, если Controller::$autoRender равно true, а затем выводит результат. В противном случае возвращается значение действия контроллера.

  • _loadController() protected
    Загружает контроллер и возвращает имя класса контроллера
  • dispatch() public

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

  • getEventManager() public

    Возвращает экземпляр CakeEventManager или создает его, если он не был создан. Прикрепляет стандартных обработчиков и фильтры

  • implementedEvents() public
    Возвращает список событий, на которые подписывается этот объект.
  • parseParams() public

    Применяет маршрутизацию и дополнительные параметры к запросу для обработки. Если маршруты не загружены, они будут загружены, и будет запущен app/Config/routes.php.

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

__construct()source public

__construct( string $base false )

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

Параметры

строка $base необязательно false
Базовый каталог приложения. Записывает App.base в Configure.

_attachFilters()source protected

_attachFilters( CakeEventManager $manager )

Прикрепляет все обработчики событий для этого экземпляра диспетчера. Загружает фильтры диспетчера из заданных мест.

Параметры

CakeEventManager $manager
Экземпляр менеджера событий.

Исключения

MissingDispatcherFilterException

_getController()source protected

_getController( CakeRequest $request , CakeResponse $response )

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

Параметры

CakeRequest $request
Объект запроса
CakeResponse $response
Ответ для контроллера.

Возвращает

mixed
имя контроллера, если не загружен, или объект, если загружен

_invoke()source protected

_invoke( Controller $controller , CakeRequest $request )

Инициализирует компоненты и модели, которые будет использовать контроллер. Вызывает действие контроллера и вызывает отображение, если Controller::$autoRender равно true, а затем выводит результат. В противном случае возвращается значение действия контроллера.

Параметры

Controller $controller
Контроллер для вызова
CakeRequest $request
Объект запроса для вызова контроллера.

Возвращает

CakeResponse
результирующий объект ответа

_loadController()source protected

_loadController( CakeRequest $request )

Загружает контроллер и возвращает имя класса контроллера

Параметры

CakeRequest $request
Экземпляр запроса.

Возвращает

string|boolean
Имя класса контроллера

dispatch()source public

dispatch( CakeRequest $request , CakeResponse $response , array $additionalParams array() )

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

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

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

Параметры

CakeRequest $request
Объект запроса для обработки.
CakeResponse $response
Объект ответа, в который будут помещены результаты обработки.
массив $additionalParams необязательно array()
Массив настроек ("bare", "return"), который объединяется с параметрами GET и POST

Возвращает

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

Исключения

MissingControllerException
При отсутствии контроллера.

Срабатывает

Dispatcher.beforeDispatch $this, compact('request', 'response', 'additionalParams')
Dispatcher.afterDispatch $this, compact('request', 'response')

getEventManager()source public

getEventManager( )

Возвращает экземпляр CakeEventManager или создает его, если он не был создан. Прикрепляет стандартных обработчиков и фильтры

Возвращает

CakeEventManager

implementedEvents()source public

implementedEvents( )

Возвращает список событий, на которые подписывается этот объект.

Возвращает

массив

Реализация

CakeEventListener::implementedEvents()

parseParams()source public

parseParams( CakeEvent $event )

Применяет маршрутизацию и дополнительные параметры к запросу для обработки. Если маршруты не загружены, они будут загружены, и будет запущен app/Config/routes.php.

Параметры

CakeEvent $event
содержащий запрос, ответ и дополнительные параметры

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

$_eventManagersource

protected CakeEventManager

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

© 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/2.10/class-Dispatcher.html

Spec-Zone.ru

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