1. class
  2. Windwalker
  3. Core
  4. Event
  5. EventDispatcher

EventDispatcher

class EventDispatcher extends Dispatcher (View source)

The EventDispatcher class.

Methods

Event
triggerEvent(Event|string $event, array $args = array())

Trigger an event.

EventDispatcher
addListener(object|Closure $listener, array|integer $priorities = array())

Add a listener to this dispatcher, only if not already registered to these events.

array
getCollector()

Method to get property Collector

EventDispatcher
setCollector(array $collector)

Method to set property collector

boolean
getDebug()

Method to get property Debug

EventDispatcher
setDebug(boolean $debug)

Method to set property debug

Details

at line line 42
Event triggerEvent(Event|string $event, array $args = array())

Trigger an event.

Parameters

Event|string $event The event object or name.
array $args The arguments.

Return Value

Event The event after being passed through all listeners.

at line line 140
EventDispatcher addListener(object|Closure $listener, array|integer $priorities = array())

Add a listener to this dispatcher, only if not already registered to these events.

If no events are specified, it will be registered to all events matching it's methods name. In the case of a closure, you must specify at least one event name.

Parameters

object|Closure $listener The listener
array|integer $priorities An associative array of event names as keys and the corresponding listener priority as values.

Return Value

EventDispatcher This method is chainable.

Exceptions

InvalidArgumentException

at line line 152
array getCollector()

Method to get property Collector

Return Value

array

at line line 164
EventDispatcher setCollector(array $collector)

Method to set property collector

Parameters

array $collector

Return Value

EventDispatcher Return self to support chaining.

at line line 176
boolean getDebug()

Method to get property Debug

Return Value

boolean

at line line 188
EventDispatcher setDebug(boolean $debug)

Method to set property debug

Parameters

boolean $debug

Return Value

EventDispatcher Return self to support chaining.