1. interface
  2. Illuminate
  3. \
  4. Contracts
  5. \
  6. Events
  7. \
  8. Dispatcher

Dispatcher

interface Dispatcher

Methods

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

Register an event listener with the dispatcher.

bool
hasListeners(string $eventName)

Determine if a given event has listeners.

void
subscribe(object|string $subscriber)

Register an event subscriber with the dispatcher.

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

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

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

Dispatch an event and call the listeners.

void
push(string $event, array $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 of the queued listeners.

Details

at line 14
void listen(string|array $events, mixed $listener)

Register an event listener with the dispatcher.

Parameters

string|array $events
mixed $listener

Return Value

void

at line 22
bool hasListeners(string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

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

Register an event subscriber with the dispatcher.

Parameters

object|string $subscriber

Return Value

void

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

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

Parameters

string|object $event
mixed $payload

Return Value

array|null

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

Dispatch an event and call the listeners.

Parameters

string|object $event
mixed $payload
bool $halt

Return Value

array|null

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

Register an event and payload to be fired later.

Parameters

string $event
array $payload

Return Value

void

at line 66
void flush(string $event)

Flush a set of pushed events.

Parameters

string $event

Return Value

void

at line 74
void forget(string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

at line 81
void forgetPushed()

Forget all of the queued listeners.

Return Value

void