Класс CakeEventManager

_attachSubscriberисходный код protected

_attachSubscriber( CakeEventListener $subscriber )

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

Параметры

CakeEventListener $subscriber

Обработчик событий.

_detachSubscriberисходный код protected

_detachSubscriber( CakeEventListener $subscriber , string $eventKey null )

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

Параметры

CakeEventListener $subscriber

обработчик, который необходимо отключить

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

необязательное имя ключа события для отключения обработчика от него

_extractCallableисходный код protected

_extractCallable( array $function , CakeEventListener $object )

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

Параметры

массив $function

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

CakeEventListener $object

объект обработчика

Возвращает

callable
обратный вызов

attachисходный код 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исходный код public

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

Удаляет обработчик из активных обработчиков.

Параметры

обратный вызов|CakeEventListener $callable

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

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

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

dispatchисходный код public

dispatch( string|CakeEvent $event )

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

Параметры

строка|CakeEvent $event

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

Возвращает

CakeEvent
CakeEvent

Срабатывает

$event

instanceисходный код public static

instance( CakeEventManager $manager null )

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

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

Параметры

CakeEventManager $manager необязательно null

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

Возвращает

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

listenersисходный код public

listeners( string $eventKey )

Возвращает список всех обработчиков для eventKey в порядке их вызова

Параметры

строка $eventKey

Ключ события.

Возвращает

array
массив

prioritisedListenersисходный код public

prioritisedListeners( string $eventKey )

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

Параметры

строка $eventKey

Ключ события.

Возвращает

array
массив

null

false

array()

10