EventEmitter
in package
Facade to simplify the registration of events and listeners and the emitting of events.
Table of Contents
Properties
Methods
- __construct() : mixed
- emit() : void
- Emits an event across all broadcasters to all registered listeners.
- registerBroadcaster() : void
- Registers a new broadcaster.
- registerListener() : void
- Registers a listener to an event.
- registerListeners() : void
- Maps an array of events to an array of listeners.
Properties
$_emitter
private
Emitter
$_emitter
Methods
__construct()
public
__construct() : mixed
emit()
Emits an event across all broadcasters to all registered listeners.
public
emit(mixed $event) : void
Parameters
- $event : mixed
registerBroadcaster()
Registers a new broadcaster.
public
registerBroadcaster(IBroadcaster $broadcaster) : void
Parameters
- $broadcaster : IBroadcaster
registerListener()
Registers a listener to an event.
public
registerListener(string $eventName, string $listener) : void
Parameters
- $eventName : string
- $listener : string
registerListeners()
Maps an array of events to an array of listeners.
public
registerListeners(array<string|int, mixed> $registry) : void
Listeners can either be an object or a class name to be instantiated when the event is fired.
Parameters
- $registry : array<string|int, mixed>