Dispatcher
class Dispatcher implements Dispatcher (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Container | $container | The IoC container instance. |
|
| protected array<string, callable|array|class-string|null> | $listeners | The registered event listeners. |
|
| protected Closure|string> | $wildcards | The wildcard listeners. |
|
| protected Closure|string> | $wildcardsCache | The cached wildcard listeners. |
|
| protected Queue | $queueResolver | The queue resolver instance. |
|
| protected callable | $transactionManagerResolver | The database transaction manager resolver instance. |
|
| protected array | $deferredEvents | The currently deferred events. |
|
| protected bool | $deferringEvents | Indicates if events should be deferred. |
|
| protected string[]|null | $eventsToDefer | The specific events to defer (null means defer all events). |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Get the class name of the first parameter of the given Closure.
Get the class names of the first parameter of the given Closure, including union types.
Get the class names / types of the parameters of the given Closure.
Get the class names / types of the return type of the given Closure.
Determine if a given event has listeners.
Determine if the given event has any wildcard listeners.
Register an event and payload to be fired later.
Flush a set of pushed events.
Register an event subscriber with the dispatcher.
Resolve the subscriber instance.
Fire an event until the first non-null response is returned.
Fire an event and call the listeners.
Broadcast an event and call its listeners.
Parse the given event and payload and prepare them for dispatching.
Determine if the payload has a broadcastable event.
Check if the event should be broadcasted by the condition.
Get all of the listeners for a given event name.
Get the wildcard listeners for the event.
Add the listeners for the event's interfaces to the given array.
Prepare the listeners for a given event.
Register an event listener with the dispatcher.
Create a class based listener using the IoC container.
Create the class based event callable.
Parse the class listener into class and method.
Determine if the event handler class should be queued.
Create a callable for putting an event handler on the queue.
Determine if the given event handler should be dispatched after all database transactions have committed.
Create a callable for dispatching a listener after database transactions.
Determine if the event handler wants to be queued.
Queue the handler class.
Create the listener and job for a queued listener.
Propagate listener options to the job.
Remove a set of listeners from the dispatcher.
Forget all of the pushed listeners.
Get the queue implementation from the resolver.
Set the queue resolver implementation.
Get the database transaction manager implementation from the resolver.
Set the database transaction manager resolver implementation.
Execute the given callback while deferring events, then dispatch all deferred events.
Determine if the given event should be deferred.
Gets the raw, unprepared listeners.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
protected string
firstClosureParameterType(Closure $closure)
Get the class name of the first parameter of the given Closure.
protected array
firstClosureParameterTypes(Closure $closure)
Get the class names of the first parameter of the given Closure, including union types.
protected array
closureParameterTypes(Closure $closure)
Get the class names / types of the parameters of the given Closure.
protected list<class-string>
closureReturnTypes(Closure $closure)
Get the class names / types of the return type of the given Closure.
__construct(Container|null $container = null)
Create a new event dispatcher instance.
void
listen(Closure|string|array $events, Closure|string|array|null $listener = null)
Register an event listener with the dispatcher.
protected void
setupWildcardListen(string $event, Closure|string $listener)
Setup a wildcard listener callback.
bool
hasListeners(string $eventName)
Determine if a given event has listeners.
bool
hasWildcardListeners(string $eventName)
Determine if the given event has any wildcard 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
subscribe(object|string $subscriber)
Register an event subscriber with the dispatcher.
protected ($subscriber is object ? object : mixed)
resolveSubscriber(object|class-string $subscriber)
Resolve the subscriber instance.
mixed
until(string|object $event, mixed $payload = [])
Fire an event until the first non-null response is returned.
array|null
dispatch(string|object $event, mixed $payload = [], bool $halt = false)
Fire an event and call the listeners.
protected array|null
invokeListeners(string|object $event, mixed $payload, bool $halt = false)
Broadcast an event and call its listeners.
protected array{string, array}
parseEventAndPayload(mixed $event, mixed $payload)
Parse the given event and payload and prepare them for dispatching.
protected bool
shouldBroadcast(array $payload)
Determine if the payload has a broadcastable event.
protected bool
broadcastWhen(mixed $event)
Check if the event should be broadcasted by the condition.
protected void
broadcastEvent(ShouldBroadcast $event)
Broadcast the given event class.
array
getListeners(string $eventName)
Get all of the listeners for a given event name.
protected array
getWildcardListeners(string $eventName)
Get the wildcard listeners for the event.
protected array
addInterfaceListeners(string $eventName, array $listeners = [])
Add the listeners for the event's interfaces to the given array.
protected Closure[]
prepareListeners(string $eventName)
Prepare the listeners for a given event.
Closure
makeListener(Closure|string|array{class-string, string} $listener, bool $wildcard = false)
Register an event listener with the dispatcher.
Closure
createClassListener(string $listener, bool $wildcard = false)
Create a class based listener using the IoC container.
protected callable
createClassCallable(array{class-string, string}|string $listener)
Create the class based event callable.
protected array{class-string, string}
parseClassCallable(string $listener)
Parse the class listener into class and method.
protected bool
handlerShouldBeQueued(class-string $class)
Determine if the event handler class should be queued.
protected Closure(): void
createQueuedHandlerCallable(class-string $class, string $method)
Create a callable for putting an event handler on the queue.
protected bool
handlerShouldBeDispatchedAfterDatabaseTransactions(mixed $listener)
Determine if the given event handler should be dispatched after all database transactions have committed.
protected Closure
createCallbackForListenerRunningAfterCommits(mixed $listener, string $method)
Create a callable for dispatching a listener after database transactions.
protected bool
handlerWantsToBeQueued(class-string $class, array $arguments)
Determine if the event handler wants to be queued.
protected void
queueHandler(string $class, string $method, array $arguments)
Queue the handler class.
protected TListener, mixed}
createListenerAndJob(TListener> $class, string $method, array $arguments)
Create the listener and job for a queued listener.
protected CallQueuedListener
propagateListenerOptions(mixed $listener, CallQueuedListener $job)
Propagate listener options to the job.
void
forget(string $event)
Remove a set of listeners from the dispatcher.
void
forgetPushed()
Forget all of the pushed listeners.
protected Queue
resolveQueue()
Get the queue implementation from the resolver.
$this
setQueueResolver(callable $resolver)
Set the queue resolver implementation.
protected DatabaseTransactionsManager|null
resolveTransactionManager()
Get the database transaction manager implementation from the resolver.
$this
setTransactionManagerResolver(callable $resolver)
Set the database transaction manager resolver implementation.
TResult
defer(callable $callback, array|null $events = null)
Execute the given callback while deferring events, then dispatch all deferred events.
protected bool
shouldDeferEvent(string $event)
Determine if the given event should be deferred.
array
getRawListeners()
Gets the raw, unprepared listeners.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.