class QueuedCommand implements ShouldQueue (View source)

Traits

Properties

string|null $connection

The name of the connection the job should be sent to.

from  Queueable
string|null $queue

The name of the queue the job should be sent to.

from  Queueable
string|null $chainConnection

The name of the connection the chain should be sent to.

from  Queueable
string|null $chainQueue

The name of the queue the chain should be sent to.

from  Queueable
array|null $chainCatchCallbacks

The callbacks to be executed on chain failure.

from  Queueable
DateTimeInterface|DateInterval|int|null $delay

The number of seconds before the job should be made available.

from  Queueable
bool|null $afterCommit

Indicates whether the job should be dispatched after all database transactions have committed.

from  Queueable
array $middleware

The middleware the job should be dispatched through.

from  Queueable
array $chained

The jobs that should run if this job is successful.

from  Queueable
protected array $data

The data to pass to the Artisan command.

Methods

static PendingDispatch
dispatch(...$arguments)

Dispatch the job with the given arguments.

dispatchIf(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

dispatchUnless(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

static mixed
dispatchSync(...$arguments)

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

static mixed
dispatchNow(...$arguments) deprecated

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

static mixed
dispatchAfterResponse(...$arguments)

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

static PendingChain
withChain(array $chain)

Set the jobs that should run if this job is successful.

$this
onConnection(string|null $connection)

Set the desired connection for the job.

$this
onQueue(string|null $queue)

Set the desired queue for the job.

$this
allOnConnection(string|null $connection)

Set the desired connection for the chain.

$this
allOnQueue(string|null $queue)

Set the desired queue for the chain.

$this
delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay in seconds for the job.

$this
afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

$this
beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

$this
through(array|object $middleware)

Specify the middleware the job should be dispatched through.

$this
chain(array $chain)

Set the jobs that should run if this job is successful.

string
serializeJob(mixed $job)

Serialize a job for queuing.

void
dispatchNextJobInChain()

Dispatch the next job on the chain.

void
invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

void
__construct(array $data)

Create a new job instance.

void
handle(Kernel $kernel)

Handle the job.

Details

static PendingDispatch dispatch(...$arguments)

Dispatch the job with the given arguments.

Parameters

...$arguments

Return Value

PendingDispatch

static PendingDispatch|Fluent dispatchIf(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments if the given truth test passes.

Parameters

bool $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent

static PendingDispatch|Fluent dispatchUnless(bool $boolean, mixed ...$arguments)

Dispatch the job with the given arguments unless the given truth test passes.

Parameters

bool $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync(...$arguments)

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

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

Parameters

...$arguments

Return Value

mixed

static mixed dispatchNow(...$arguments) deprecated

deprecated Will be removed in a future Laravel version.

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

Parameters

...$arguments

Return Value

mixed

static mixed dispatchAfterResponse(...$arguments)

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

Parameters

...$arguments

Return Value

mixed

static PendingChain withChain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

PendingChain

$this onConnection(string|null $connection)

Set the desired connection for the job.

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

Set the desired queue for the job.

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

Parameters

string|null $queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|int|null $delay)

Set the desired delay in seconds for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

Return Value

$this

$this afterCommit()

Indicate that the job should be dispatched after all database transactions have committed.

Return Value

$this

$this beforeCommit()

Indicate that the job should not wait until database transactions have been committed before dispatching.

Return Value

$this

$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

Set the jobs that should run if this job is successful.

Parameters

array $chain

Return Value

$this

protected string serializeJob(mixed $job)

Serialize a job for queuing.

Parameters

mixed $job

Return Value

string

Exceptions

RuntimeException

void dispatchNextJobInChain()

Dispatch the next job on the chain.

Return Value

void

void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

Parameters

Throwable $e

Return Value

void

void __construct(array $data)

Create a new job instance.

Parameters

array $data

Return Value

void

void handle(Kernel $kernel)

Handle the job.

Parameters

Kernel $kernel

Return Value

void