interface Dispatcher (View source)

Methods

void
listen(string|array $events, mixed $listener, int $priority)

Register an event listener with the dispatcher.

bool
hasListeners(string $eventName)

Determine if a given event has listeners.

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

Register an event and payload to be fired later.

void
subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

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

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

void
flush(string $event)

Flush a set of pushed events.

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

Fire an event and call the listeners.

string
firing()

Get the event that is currently firing.

void
forget(string $event)

Remove a set of listeners from the dispatcher.

void
forgetPushed()

Forget all of the queued listeners.

Details

void listen(string|array $events, mixed $listener, int $priority)

Register an event listener with the dispatcher.

Parameters

string|array $events
mixed $listener
int $priority

Return Value

void

bool hasListeners(string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

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

Register an event and payload to be fired later.

Parameters

string $event
array $payload

Return Value

void

void subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

Parameters

object|string $subscriber

Return Value

void

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

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

Parameters

string $event
array $payload

Return Value

mixed

void flush(string $event)

Flush a set of pushed events.

Parameters

string $event

Return Value

void

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

Fire an event and call the listeners.

Parameters

string|object $event
mixed $payload
bool $halt

Return Value

array|null

string firing()

Get the event that is currently firing.

Return Value

string

void forget(string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

void forgetPushed()

Forget all of the queued listeners.

Return Value

void