Spec-Zone.ru › CakePHP 3.4

Класс 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
    Добавить фильтр в этот диспетчер.
  • 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

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
Изменённый/заменённый ответ.

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

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

Устарело

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–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.4/class-Cake.Http.ActionDispatcher.html

Spec-Zone.ru

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