Dispatcher

class Dispatcher (View source)

Properties

protected Container $container The IoC container instance.
protected array $listeners The registered event listeners.
protected array $wildcards The wildcard listeners.
protected array $sorted The sorted event listeners.
protected array $firing The event firing stack.

Methods

void __construct(Container $container = null)

Create a new event dispatcher instance.
void listen(string|array $events, mixed $listener, int $priority)

Register an event listener with the dispatcher.
void setupWildcardListen(string $event, mixed $listener)

Setup a wildcard listener callback.
bool hasListeners(string $eventName)

Determine if a given event has listeners.
void queue(string $event, array $payload = array())

Register a queued event and payload.
void subscribe(string $subscriber)

Register an event subscriber with the dispatcher.
mixed resolveSubscriber(mixed $subscriber)

Resolve the subscriber instance.
mixed until(string $event, array $payload = array())

Fire an event until the first non-null response is returned.
void flush(string $event)

Flush a set of queued events.
string firing()

Get the event that is currently firing.
array|null fire(string $event, mixed $payload = array(), bool $halt = false)

Fire an event and call the listeners.
array getListeners(string $eventName)

Get all of the listeners for a given event name.
array getWildcardListeners(string $eventName)

Get the wildcard listeners for the event.
array sortListeners(string $eventName)

Sort the listeners for a given event by priority.
mixed makeListener(mixed $listener)

Register an event listener with the dispatcher.
Closure createClassListener(mixed $listener)

Create a class based listener using the IoC container.
void forget(string $event)

Remove a set of listeners from the dispatcher.
void forgetQueued()

Forget all of the queued listeners.

Details

void __construct(Container $container = null)

Create a new event dispatcher instance.

Parameters

Container $container

Return Value

void

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

protected void setupWildcardListen(string $event, mixed $listener)

Setup a wildcard listener callback.

Parameters

string $event
mixed $listener

Return Value

void

bool hasListeners(string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

void queue(string $event, array $payload = array())

Register a queued event and payload.

Parameters

string $event
array $payload

Return Value

void

void subscribe(string $subscriber)

Register an event subscriber with the dispatcher.

Parameters

string $subscriber

Return Value

void

protected mixed resolveSubscriber(mixed $subscriber)

Resolve the subscriber instance.

Parameters

mixed $subscriber

Return Value

mixed

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

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 queued events.

Parameters

string $event

Return Value

void

string firing()

Get the event that is currently firing.

Return Value

string

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

Fire an event and call the listeners.

Parameters

string $event
mixed $payload
bool $halt

Return Value

array|null

array getListeners(string $eventName)

Get all of the listeners for a given event name.

Parameters

string $eventName

Return Value

array

protected array getWildcardListeners(string $eventName)

Get the wildcard listeners for the event.

Parameters

string $eventName

Return Value

array

protected array sortListeners(string $eventName)

Sort the listeners for a given event by priority.

Parameters

string $eventName

Return Value

array

mixed makeListener(mixed $listener)

Register an event listener with the dispatcher.

Parameters

mixed $listener

Return Value

mixed

Closure createClassListener(mixed $listener)

Create a class based listener using the IoC container.

Parameters

mixed $listener

Return Value

Closure

void forget(string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

void forgetQueued()

Forget all of the queued listeners.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Events/Dispatcher.html