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 | $listeners | The registered event listeners. |
|
| protected array | $wildcards | The wildcard listeners. |
|
| protected array | $wildcardsCache | The cached wildcard listeners. |
|
| protected callable | $queueResolver | The queue resolver instance. |
Methods
| static void | macro(string $name, object|callable $macro) Register a custom macro. |
from Macroable |
| static void | mixin(object $mixin, bool $replace = true) Mix another object into the class. |
from Macroable |
| static bool | hasMacro(string $name) Checks if macro is registered. |
from Macroable |
| static void | flushMacros() Flush the existing macros. |
from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Dynamically handle calls to the class. |
from Macroable |
| mixed | __call(string $method, array $parameters) Dynamically handle calls to the class. |
from Macroable |
| string | firstClosureParameterType(Closure $closure) Get the class name of the first parameter of the given Closure. |
from ReflectsClosures |
| array | firstClosureParameterTypes(Closure $closure) Get the class names of the first parameter of the given Closure, including union types. |
from ReflectsClosures |
| array | closureParameterTypes(Closure $closure) Get the class names / types of the parameters of the given Closure. |
from ReflectsClosures |
| void | __construct(Container $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. |
|
| 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. |
|
| mixed | resolveSubscriber(object|string $subscriber) Resolve the subscriber instance. |
|
| array|null | 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. |
|
| array | parseEventAndPayload(mixed $event, mixed $payload) Parse the given event and payload and prepare them for dispatching. |
|
| bool | shouldBroadcast(array $payload) Determine if the payload has a broadcastable event. |
|
| bool | broadcastWhen(mixed $event) Check if the event should be broadcasted by the condition. |
|
| void | broadcastEvent(ShouldBroadcast $event) Broadcast the given event class. |
|
| 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 | addInterfaceListeners(string $eventName, array $listeners = []) Add the listeners for the event's interfaces to the given array. |
|
| Closure[] | prepareListeners(string $eventName) Prepare the listeners for a given event. |
|
| Closure | makeListener(Closure|string|array $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. |
|
| callable | createClassCallable(array|string $listener) Create the class based event callable. |
|
| array | parseClassCallable(string $listener) Parse the class listener into class and method. |
|
| bool | handlerShouldBeQueued(string $class) Determine if the event handler class should be queued. |
|
| Closure | createQueuedHandlerCallable(string $class, string $method) Create a callable for putting an event handler on the queue. |
|
| bool | handlerShouldBeDispatchedAfterDatabaseTransactions(object|mixed $listener) Determine if the given event handler should be dispatched after all database transactions have committed. |
|
| Closure | createCallbackForListenerRunningAfterCommits(mixed $listener, string $method) Create a callable for dispatching a listener after database transactions. |
|
| bool | handlerWantsToBeQueued(string $class, array $arguments) Determine if the event handler wants to be queued. |
|
| void | queueHandler(string $class, string $method, array $arguments) Queue the handler class. |
|
| array | createListenerAndJob(string $class, string $method, array $arguments) Create the listener and job for a queued listener. |
|
| mixed | 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. |
|
| Queue | resolveQueue() Get the queue implementation from the resolver. |
|
| $this | setQueueResolver(callable $resolver) Set the queue resolver implementation. |
|
| array | getRawListeners() 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.
void __construct(Container $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 mixed resolveSubscriber(object|string $subscriber)
Resolve the subscriber instance.
array|null 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 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 $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|string $listener)
Create the class based event callable.
protected array parseClassCallable(string $listener)
Parse the class listener into class and method.
protected bool handlerShouldBeQueued(string $class)
Determine if the event handler class should be queued.
protected Closure createQueuedHandlerCallable(string $class, string $method)
Create a callable for putting an event handler on the queue.
protected bool handlerShouldBeDispatchedAfterDatabaseTransactions(object|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(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 array createListenerAndJob(string $class, string $method, array $arguments)
Create the listener and job for a queued listener.
protected mixed 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.
array getRawListeners()
Gets the raw, unprepared listeners.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Events/Dispatcher.html