Класс CakeEventManager
Менеджер событий отвечает за отслеживание слушателей событий, передачу им правильных данных и их срабатывание в правильном порядке, когда связанные события запускаются. Вы можете создавать несколько экземпляров этого объекта для управления локальными событиями или сохранять один экземпляр и передавать его для управления всеми событиями в вашем приложении.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Event/CakeEventManager.php
Краткое описание свойств
- Глобально доступный экземпляр, используемый для отправки событий, присоединенных из любого контекста
-
$_isGlobalprotectedВнутренний флаг для различения общего менеджера от синглтонаboolean -
$_listenersprotectedСписок обратных вызовов слушателей, связанных сobject - Значение очереди приоритетов по умолчанию для новых присоединенных слушателей
integer
Краткое описание методов
- _attachSubscriber() protected
Вспомогательная функция для присоединения всех реализованных обратных вызовов экземпляра класса CakeEventListener в качестве отдельных методов к этому менеджеру
- _detachSubscriber() protectedВспомогательная функция для отсоединения всех слушателей, предоставленных объектом, реализующим CakeEventListener
- _extractCallable() protected
Вспомогательная функция для извлечения и возврата типа обратного вызова PHP из определения вызываемого объекта, возвращаемого методом
implementedEventsобъекта CakeEventListener - attach() publicДобавляет нового слушателя к событию. Слушатели
- detach() publicУдаляет слушателя из активных слушателей.
- dispatch() publicОтправляет новое событие всем настроенным слушателям
-
Возвращает глобально доступный экземпляр 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 - объект обработчика
Возвращает
callableattach()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Вызывает
$eventinstance()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
$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