Dispatcher
class Dispatcher implements QueueingDispatcher (View source)
Properties
| protected Container | $container | The container implementation. | |
| protected Pipeline | $pipeline | The pipeline instance for the bus. | |
| protected array | $pipes | The pipes to send commands through before dispatching. | |
| protected array | $handlers | The command to handler mapping for non-self-handling events. | |
| protected Closure|null | $queueResolver | The queue resolver callback. |
Methods
| void | __construct(Container $container, Closure $queueResolver = null) Create a new command dispatcher instance. | |
| mixed | dispatch(mixed $command) Dispatch a command to its appropriate handler. | |
| mixed | dispatchSync(mixed $command, mixed $handler = null) Dispatch a command to its appropriate handler in the current process. | |
| mixed | dispatchNow(mixed $command, mixed $handler = null) Dispatch a command to its appropriate handler in the current process without using the synchronous queue. | |
| Batch|null | findBatch(string $batchId) Attempt to find the batch with the given ID. | |
| PendingBatch | batch(Collection|array $jobs) Create a new batch of queueable jobs. | |
| PendingChain | chain(Collection|array $jobs) Create a new chain of queueable jobs. | |
| bool | hasCommandHandler(mixed $command) Determine if the given command has a handler. | |
| bool|mixed | getCommandHandler(mixed $command) Retrieve the handler for a command. | |
| bool | commandShouldBeQueued(mixed $command) Determine if the given command should be queued. | |
| mixed | dispatchToQueue(mixed $command) Dispatch a command to its appropriate handler behind a queue. | |
| mixed | pushCommandToQueue(Queue $queue, mixed $command) Push the command onto the given queue instance. | |
| void | dispatchAfterResponse(mixed $command, mixed $handler = null) Dispatch a command to its appropriate handler after the current process. | |
| $this | pipeThrough(array $pipes) Set the pipes through which commands should be piped before dispatching. | |
| $this | map(array $map) Map a command to a handler. |
Details
void __construct(Container $container, Closure $queueResolver = null)
Create a new command dispatcher instance.
mixed dispatch(mixed $command)
Dispatch a command to its appropriate handler.
mixed dispatchSync(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler in the current process.
Queuable jobs will be dispatched to the "sync" queue.
mixed dispatchNow(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler in the current process without using the synchronous queue.
Batch|null findBatch(string $batchId)
Attempt to find the batch with the given ID.
PendingBatch batch(Collection|array $jobs)
Create a new batch of queueable jobs.
PendingChain chain(Collection|array $jobs)
Create a new chain of queueable jobs.
bool hasCommandHandler(mixed $command)
Determine if the given command has a handler.
bool|mixed getCommandHandler(mixed $command)
Retrieve the handler for a command.
protected bool commandShouldBeQueued(mixed $command)
Determine if the given command should be queued.
mixed dispatchToQueue(mixed $command)
Dispatch a command to its appropriate handler behind a queue.
protected mixed pushCommandToQueue(Queue $queue, mixed $command)
Push the command onto the given queue instance.
void dispatchAfterResponse(mixed $command, mixed $handler = null)
Dispatch a command to its appropriate handler after the current process.
$this pipeThrough(array $pipes)
Set the pipes through which commands should be piped before dispatching.
$this map(array $map)
Map a command to a handler.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Bus/Dispatcher.html