1. Documentation
  2. API
  3. Library
  4. Support
  5. Traits
  6. Emitter

October\Rain\Support\Traits\Emitter

Overview

Emitter adds event related features to any class

Protected Properties

protected array $emitterSingleEventCollection

emitterSingleEventCollection of events to be fired once only

protected array $emitterEventCollection

emitterEventCollection of all registered events

protected array $emitterEventSorted

emitterEventSorted collection

Public Methods

public bindEvent()

public bindEvent($event, $callback, $priority = 0): void

bindEvent creates a new event binding

public bindEventOnce()

public bindEventOnce($event, $callback, $priority = 0): void

bindEventOnce creates a new event binding that fires once only

public fireEvent()

public fireEvent(
    string $event,
    array $params = [],
    boolean $halt = false
): array

fireEvent and call the listeners

public unbindEvent()

public unbindEvent($event = null): void

unbindEvent destroys an event binding

Protected Methods

protected emitterEventSortEvents()

protected emitterEventSortEvents($eventName, $combined = []): array

emitterEventSortEvents sorts the listeners for a given event by priority