Spec-Zone.ru › CakePHP 2.8

Класс CakeEventManager

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

Пакет: Cake\Event
Авторские права: Авторские права (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() )

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

Параметры

callable|CakeEventListener $callable

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

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

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

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

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

Исключения

InvalidArgumentException

Если ключ события отсутствует или callable не является экземпляром CakeEventListener.


detach()source public

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

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

Параметры

callable|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.
http://api.cakephp.org/2.8/class-CakeEventManager.html

Spec-Zone.ru

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