Spec-Zone.ru › CakePHP 3.6

Класс ActionDispatcher

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

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

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

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

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

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

  • _eventClass, _eventManager

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

  • __construct() public
    Конструктор
  • _invoke() protected
    Вызов действия контроллера и методов оберток.
  • addFilter() public deprecated
    Добавить фильтр в этот диспетчер.
  • 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\Http\Response
Ответ

Выбрасывает

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

addFilter()source public deprecated

addFilter( Cake\Event\EventListenerInterface $filter )

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

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

Устарело

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

Параметры

Cake\Event\EventListenerInterface $filter

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

dispatch()source public

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

Отправляет запрос и ответ

Параметры

Cake\Http\ServerRequest $request
Запрос для отправки.
Cake\Http\Response $response
Ответ для отправки.

Возвращает

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

Выбрасывает

ReflectionException

getFilters()source public

getFilters( )

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

Возвращает

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 для данного объекта.

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

Устарело

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательно null
устанавливаемый eventManager

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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

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

Параметры

Cake\Event\EventManager $eventManager
устанавливаемый eventManager

Возвращает


$this

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

$factorysource

protected Cake\Http\ControllerFactory

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

$filterssource

protected Cake\Event\EventListenerInterface[]

Прикреплённые фильтры маршрутизации.

[]

© 2005–present 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.6/class-Cake.Http.ActionDispatcher.html

Spec-Zone.ru

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