Spec-Zone.ru › CakePHP 3.3

Класс ActionDispatcher

Этот класс обеспечивает совместимость с фильтрами диспетчера и взаимодействием с уровнями контроллера.

В долгосрочной перспективе это должен быть просто диспетчер контроллера, но пока он будет делать немного больше.

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

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

  • $factory protected
    Cake\Http\ControllerFactory
    Экземпляр фабрики контроллеров.
  • $filters protected
    array
    Присоединённые фильтры маршрутизации

Унаследованные свойства

  • _eventClass, _eventManager

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

  • __construct() public
    Конструктор
  • _invoke() protected
    Вызов действия контроллера и обертывающих методов.
  • addFilter() public
    Добавление фильтра в этот диспетчер.
  • dispatch() public
    Диспетчеризация запроса и ответа
  • getFilters() public
    Получение подключённых фильтров.

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

__construct()source public

__construct( Cake\Http\ControllerFactory|null $factory null , Cake\Event\EventManager|null $eventManager null , array $filters [] )

Конструктор

Параметры

Cake\Http\ControllerFactory|null $factory необязательно null
Экземпляр фабрики контроллеров.
Cake\Event\EventManager|null $eventManager необязательно null
Менеджер событий, если вы хотите его ввести.
array $filters необязательно []
Список фильтров для включения.

_invoke()source protected

_invoke( Cake\Controller\Controller $controller )

Вызов действия контроллера и обертывающих методов.

Параметры

Cake\Controller\Controller $controller
Контроллер для вызова.

Возвращает

Cake\Network\Response
Ответ

Выбрасывает

LogicException
Если действие контроллера возвращает значение, отличное от ответа.

addFilter()source public

addFilter( Cake\Event\EventListenerInterface $filter )

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

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

Устарело

Это доступно только для обратной совместимости с DispatchFilters

Параметры

Cake\Event\EventListenerInterface $filter

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

dispatch()source public

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

Диспетчеризация запроса и ответа

Параметры

Cake\Network\Request $request
Запрос для диспетчеризации.
Cake\Network\Response $response
Ответ для диспетчеризации.

Возвращает

Cake\Network\Response
Изменённый/заменённый ответ.

getFilters()source public

getFilters( )

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

Возвращает

array

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

dispatchEvent()source public

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

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

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

Параметры

string $name
Имя события.
array|null $data необязательно null

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

object|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

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

$factorysource

protected Cake\Http\ControllerFactory

Экземпляр фабрики контроллеров.

$filterssource

protected array

Присоединённые фильтры маршрутизации

[]

© 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.Http.ActionDispatcher.html

Spec-Zone.ru

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