1. trait
  2. CharlotteDunois
  3. \
  4. Events
  5. \
  6. EventEmitterErrorTrait

EventEmitterErrorTrait

trait EventEmitterErrorTrait

Our Event Emitter Error Trait. This one throws an exception if there is not an error event listener when an error event gets emitted.

Traits

EventEmitterTrait
Our Event Emitter Trait.

Properties

protected array $listeners from EventEmitterTrait
protected array $onceListeners from EventEmitterTrait

Methods

$this
on(string $event, callable $listener)

Attach a listener to an event.

from EventEmitterTrait
$this
once(string $event, callable $listener)

Attach a listener to an event, for exactly once.

from EventEmitterTrait
$this
removeListener(string $event, callable $listener)

Remove specified listener from an event.

from EventEmitterTrait
$this
removeAllListeners(string|null $event = null)

Remove all listeners from an event (or all listeners).

from EventEmitterTrait
array
listeners(string|null $event = null)

Get listeners for a specific events, or all listeners.

from EventEmitterTrait
void
emit(string $event, mixed ...$arguments)

Emits an event, catching all exceptions and emitting an error event for these exceptions.

Details

in EventEmitterTrait at line 34
$this on(string $event, callable $listener)

Attach a listener to an event.

Parameters

string $event
callable $listener

Return Value

$this

in EventEmitterTrait at line 50
$this once(string $event, callable $listener)

Attach a listener to an event, for exactly once.

Parameters

string $event
callable $listener

Return Value

$this

in EventEmitterTrait at line 66
$this removeListener(string $event, callable $listener)

Remove specified listener from an event.

Parameters

string $event
callable $listener

Return Value

$this

in EventEmitterTrait at line 95
$this removeAllListeners(string|null $event = null)

Remove all listeners from an event (or all listeners).

Parameters

string|null $event

Return Value

$this

in EventEmitterTrait at line 116
array listeners(string|null $event = null)

Get listeners for a specific events, or all listeners.

Parameters

string|null $event

Return Value

array

at line 25
void emit(string $event, mixed ...$arguments)

Emits an event, catching all exceptions and emitting an error event for these exceptions.

Parameters

string $event
mixed ...$arguments

Return Value

void

Exceptions

UnhandledErrorException Thrown when an error event goes unhandled.