1. class
  2. Illuminate
  3. Events
  4. Dispatcher

Dispatcher

class Dispatcher implements Dispatcher (View source)

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.

bool
hasListeners( string $eventName)

Determine if a given event has listeners.

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

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 = array())

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

void
flush( string $event)

Flush a set of pushed events.

string
firing()

Get the event that is currently firing.

array|null
fire( string|object $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.

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
forgetPushed()

Forget all of the pushed listeners.

$this
setQueueResolver( callable $resolver)

Set the queue resolver implementation.

Details

at line line 64
void __construct( Container $container = null)

Create a new event dispatcher instance.

Parameters

Container $container

Return Value

void

at line line 77
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

at line line 108
bool hasListeners( string $eventName)

Determine if a given event has listeners.

Parameters

string $eventName

Return Value

bool

at line line 120
void push( string $event, array $payload = array())

Register an event and payload to be fired later.

Parameters

string $event
array $payload

Return Value

void

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

Register an event subscriber with the dispatcher.

Parameters

object|string $subscriber

Return Value

void

at line line 162
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

at line line 173
void flush( string $event)

Flush a set of pushed events.

Parameters

string $event

Return Value

void

at line line 183
string firing()

Get the event that is currently firing.

Return Value

string

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

Fire an event and call the listeners.

Parameters

string|object $event
mixed $payload
bool $halt

Return Value

array|null

at line line 272
array getListeners( string $eventName)

Get all of the listeners for a given event name.

Parameters

string $eventName

Return Value

array

at line line 330
mixed makeListener( mixed $listener)

Register an event listener with the dispatcher.

Parameters

mixed $listener

Return Value

mixed

at line line 341
Closure createClassListener( mixed $listener)

Create a class based listener using the IoC container.

Parameters

mixed $listener

Return Value

Closure

at line line 458
void forget( string $event)

Remove a set of listeners from the dispatcher.

Parameters

string $event

Return Value

void

at line line 472
void forgetPushed()

Forget all of the pushed listeners.

Return Value

void

at line line 497
$this setQueueResolver( callable $resolver)

Set the queue resolver implementation.

Parameters

callable $resolver

Return Value

$this