Spec-Zone.ru › CakePHP 2.9

Класс CakeEventManager

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

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

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

  • $_generalManager protected static
    CakeEventManager
    Глобально доступный экземпляр, используемый для отправки событий, присоединенных из любого контекста
  • $_isGlobal protected
    boolean
    Внутренний флаг для различения общего менеджера от синглтона
  • $_listeners protected
    object
    Список обратных вызовов слушателей, связанных с
  • $defaultPriority public static
    integer
    Значение очереди приоритетов по умолчанию для новых присоединенных слушателей

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

  • _attachSubscriber() protected

    Вспомогательная функция для присоединения всех реализованных обратных вызовов экземпляра класса CakeEventListener в качестве отдельных методов к этому менеджеру

  • _detachSubscriber() protected
    Вспомогательная функция для отсоединения всех слушателей, предоставленных объектом, реализующим CakeEventListener
  • _extractCallable() protected

    Вспомогательная функция для извлечения и возврата типа обратного вызова PHP из определения вызываемого объекта, возвращаемого методом implementedEvents объекта CakeEventListener

  • attach() public
    Добавляет нового слушателя к событию. Слушатели
  • detach() public
    Удаляет слушателя из активных слушателей.
  • dispatch() public
    Отправляет новое событие всем настроенным слушателям
  • instance() public static

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

  • listeners() public
    Возвращает список всех слушателей для eventKey в порядке их вызова
  • prioritisedListeners() public
    Возвращает слушателей для указанного ключа события, индексированных по приоритету

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

_attachSubscriber()source protected

_attachSubscriber( CakeEventListener $subscriber )

Вспомогательная функция для присоединения всех реализованных обратных вызовов экземпляра класса CakeEventListener в качестве отдельных методов к этому менеджеру

Параметры

CakeEventListener $subscriber
Слушатель событий.

_detachSubscriber()source protected

_detachSubscriber( CakeEventListener $subscriber , string $eventKey null )

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

Параметры

CakeEventListener $subscriber
отсоединяемый слушатель
строка $eventKey необязательный null
необязательный ключ имени события для отписки слушателя

_extractCallable()source protected

_extractCallable( array $function , CakeEventListener $object )

Вспомогательная функция для извлечения и возврата типа обратного вызова PHP из определения вызываемого объекта, возвращаемого методом implementedEvents объекта CakeEventListener

Параметры

массив $function
массив, взятый из определения обработчика события
CakeEventListener $object
объект обработчика

Возвращает

callable

attach()source public

attach( callable|CakeEventListener $callable , string $eventKey null , array $options array() )

Добавляет нового слушателя к событию. Слушатели

Параметры

вызываемый объект/CakeEventListener $callable

Действительный PHP обратный вызов или экземпляр CakeEventListener, который будет вызываться при запуске события с именем $eventKey. Если передается экземпляр CakeEventListener, то метод implementedEvents будет вызван на объекте для регистрации объявленных событий индивидуально в качестве методов для управления этим классом. Можно определить несколько обработчиков событий на одно имя события.

строка $eventKey необязательный null

Уникальное идентификатор имени события, с которым будет связан обратный вызов. Если $callable является экземпляром CakeEventListener, этот аргумент будет проигнорирован

массив $options необязательный array()

используется для установки флагов priority и passParams для слушателя. Приоритеты обрабатываются как очереди, и несколько прикреплений, добавленные в одну очередь приоритетов, будут обработаны в порядке вставки. passParams означает, что свойство данных события будет преобразовано в аргументы функции при вызове слушателя. Если $called является экземпляром CakeEventListener, этот параметр будет проигнорирован

Исключение

InvalidArgumentException

Когда ключ события отсутствует или вызываемый объект не является экземпляром CakeEventListener.


detach()source public

detach( callable|CakeEventListener $callable , string $eventKey null )

Удаляет слушателя из активных слушателей.

Параметры

вызываемый объект/CakeEventListener $callable
любой действительный PHP обратный вызов или экземпляр CakeEventListener
строка $eventKey необязательный null
Уникальное имя события, с которым связан обратный вызов

dispatch()source public

dispatch( string|CakeEvent $event )

Отправляет новое событие всем настроенным слушателям

Параметры

строка/CakeEvent $event
ключ имени события или экземпляр CakeEvent

Возвращает

CakeEvent

Вызывает

$event

instance()source public static

instance( CakeEventManager $manager null )

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

Если вызван с первым параметром, он будет установлен как глобально доступный экземпляр

Параметры

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

Возвращает

CakeEventManager
глобальный менеджер событий

listeners()source public

listeners( string $eventKey )

Возвращает список всех слушателей для eventKey в порядке их вызова

Параметры

строка $eventKey
Ключ события.

Возвращает

массив

prioritisedListeners()source public

prioritisedListeners( string $eventKey )

Возвращает слушателей для указанного ключа события, индексированных по приоритету

Параметры

строка $eventKey
Ключ события.

Возвращает

массив

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

$_generalManagersource

protected static CakeEventManager

Глобальная доступная инстанция, используемая для отправки событий, присоединённых из любого контекста

null

$_isGlobalsource

protected boolean

Внутренний флаг для различения общего менеджера и синглтона

false

$_listenerssource

protected object

Список обработчиков обратных вызовов, связанных с

array()

$defaultPrioritysource

public static integer

Значение очереди по умолчанию для новых, присоединённых обработчиков

10

© 2005–2016 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.9/class-CakeEventManager.html

Spec-Zone.ru

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