1. interface
  2. Illuminate
  3. \
  4. Contracts
  5. \
  6. Bus
  7. \
  8. QueueingDispatcher

QueueingDispatcher

interface QueueingDispatcher implements Dispatcher (View source)

Methods

mixed
dispatch(mixed $command)

Dispatch a command to its appropriate handler.

from  Dispatcher
mixed
dispatchSync(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

from  Dispatcher
mixed
dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

from  Dispatcher
bool
hasCommandHandler(mixed $command)

Determine if the given command has a handler.

from  Dispatcher
bool|mixed
getCommandHandler(mixed $command)

Retrieve the handler for a command.

from  Dispatcher
$this
pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

from  Dispatcher
$this
map(array $map)

Map a command to a handler.

from  Dispatcher
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.

mixed
dispatchToQueue(mixed $command)

Dispatch a command to its appropriate handler behind a queue.

Details

in Dispatcher at line 13
mixed dispatch(mixed $command)

Dispatch a command to its appropriate handler.

Parameters

mixed $command

Return Value

mixed

in Dispatcher at line 24
mixed dispatchSync(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

Queueable jobs will be dispatched to the "sync" queue.

Parameters

mixed $command
mixed $handler

Return Value

mixed

in Dispatcher at line 33
mixed dispatchNow(mixed $command, mixed $handler = null)

Dispatch a command to its appropriate handler in the current process.

Parameters

mixed $command
mixed $handler

Return Value

mixed

in Dispatcher at line 41
bool hasCommandHandler(mixed $command)

Determine if the given command has a handler.

Parameters

mixed $command

Return Value

bool

in Dispatcher at line 49
bool|mixed getCommandHandler(mixed $command)

Retrieve the handler for a command.

Parameters

mixed $command

Return Value

bool|mixed

in Dispatcher at line 57
$this pipeThrough(array $pipes)

Set the pipes commands should be piped through before dispatching.

Parameters

array $pipes

Return Value

$this

in Dispatcher at line 65
$this map(array $map)

Map a command to a handler.

Parameters

array $map

Return Value

$this

at line 13
Batch|null findBatch(string $batchId)

Attempt to find the batch with the given ID.

Parameters

string $batchId

Return Value

Batch|null

at line 21
PendingBatch batch(Collection|array $jobs)

Create a new batch of queueable jobs.

Parameters

Collection|array $jobs

Return Value

PendingBatch

at line 29
mixed dispatchToQueue(mixed $command)

Dispatch a command to its appropriate handler behind a queue.

Parameters

mixed $command

Return Value

mixed