Spec-Zone.ru › CakePHP 3.4

Трейт EventDispatcherTrait

Реализует Cake\Event\EventDispatcherInterface.

Прямые пользователи

  • Cake\Controller\Component\AuthComponent
  • Cake\Controller\ComponentRegistry
  • Cake\View\HelperRegistry
  • Cake\View\View
  • Cake\Controller\Controller
  • Cake\Event\EventManagerTrait
  • Cake\Http\ActionDispatcher
  • Cake\Http\Server
  • Cake\ORM\BehaviorRegistry
  • Cake\ORM\Table
  • Cake\Routing\Dispatcher
  • Cake\View\Cell

Косвенные пользователи

  • Cake\Controller\ErrorController
  • Cake\View\AjaxView
  • Cake\View\JsonView
  • Cake\View\SerializedView
  • Cake\View\XmlView
Пространство имен: Cake\Event
Расположение: Event/EventDispatcherTrait.php

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

  • $_eventClass protected
    string
    Имя класса по умолчанию для новых объектов событий.
  • $_eventManager protected
    Cake\Event\EventManager

    Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

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

  • dispatchEvent() public
    Обёртка для создания и отправки событий.
  • eventManager() public
    Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.
  • getEventManager() public
    Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.
  • setEventManager() public
    Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.

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

dispatchEvent()source public

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

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

Возвращает событие, которое было отправлено.

Параметры

string $name
Имя события.
array|null $data optional null

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

object|null $subject optional 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 optional 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

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

$_eventClasssource

protected string

Имя класса по умолчанию для новых объектов событий.

'\Cake\Event\Event'

$_eventManagersource

protected Cake\Event\EventManager

Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.

© 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.Event.EventDispatcherTrait.html

Spec-Zone.ru

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