interface Dispatcher

Methods

void
listen(array|Closure|QueuedClosure|string $events, array|object|string|null $listener = null)

Register an event listener with the dispatcher.

void
observe(array|string $events, array|object|string $observer)

Register a passive event observer.

bool
hasListeners(string $eventName)

Determine if a given event has listeners.

void
subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

mixed
until(object|string $event, mixed $payload = [])

Dispatch an event until the first non-null response is returned.

mixed
dispatch(object|string $event, mixed $payload = [], bool $halt = false)

Dispatch an event and call the listeners.

void
push(string $event, mixed $payload = [])

Register an event and payload to be fired later.

void
flush(string $event)

Flush a set of pushed events.

void
forget(string $event)

Remove a set of listeners from the dispatcher.

void
forgetPushed()

Forget all events queued via push() in the current coroutine.

Details

at line 15
void listen(array|Closure|QueuedClosure|string $events, array|object|string|null $listener = null)

Register an event listener with the dispatcher.

Parameters

array|Closure|QueuedClosure|string $events
array|object|string|null $listener

Return Value

void

at line 25
void observe(array|string $events, array|object|string $observer)

Register a passive event observer.

Observers receive dispatched events but are not counted by hasListeners().

Parameters

array|string $events
array|object|string $observer

Return Value

void

at line 30
bool hasListeners(string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

at line 35
void subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

Parameters

object|string $subscriber

Return Value

void

at line 40
mixed until(object|string $event, mixed $payload = [])

Dispatch an event until the first non-null response is returned.

Parameters

object|string $event
mixed $payload

Return Value

mixed

at line 45
mixed dispatch(object|string $event, mixed $payload = [], bool $halt = false)

Dispatch an event and call the listeners.

Parameters

object|string $event
mixed $payload
bool $halt

Return Value

mixed

at line 50
void push(string $event, mixed $payload = [])

Register an event and payload to be fired later.

Parameters

string $event
mixed $payload

Return Value

void

at line 55
void flush(string $event)

Flush a set of pushed events.

Parameters

string $event

Return Value

void

at line 60
void forget(string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

at line 65
void forgetPushed()

Forget all events queued via push() in the current coroutine.

Return Value

void