QueuedCommand

class QueuedCommand implements ShouldQueue (View source)

Traits

Dispatchable
Queueable

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
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()

Dispatch the job with the given arguments.

 from Dispatchable
static PendingDispatch|Fluent dispatchIf($boolean, ...$arguments)

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

 from Dispatchable
static PendingDispatch|Fluent dispatchUnless($boolean, ...$arguments)

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

 from Dispatchable
static mixed dispatchSync()

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

 from Dispatchable
static mixed dispatchNow()

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

 from Dispatchable
static mixed dispatchAfterResponse()

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

 from Dispatchable
static PendingChain withChain(array $chain)

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

 from Dispatchable
$this onConnection(string|null $connection)

Set the desired connection for the job.

 from Queueable
$this onQueue(string|null $queue)

Set the desired queue for the job.

 from Queueable
$this allOnConnection(string|null $connection)

Set the desired connection for the chain.

 from Queueable
$this allOnQueue(string|null $queue)

Set the desired queue for the chain.

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

Set the desired delay for the job.

 from Queueable
$this through(array|object $middleware)

Specify the middleware the job should be dispatched through.

 from Queueable
$this chain(array $chain)

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

 from Queueable
string serializeJob(mixed $job)

Serialize a job for queuing.

 from Queueable
void dispatchNextJobInChain()

Dispatch the next job on the chain.

 from Queueable
void invokeChainCatchCallbacks(Throwable $e)

Invoke all of the chain's failed job callbacks.

 from Queueable
void __construct(array $data)

Create a new job instance.
void handle(Kernel $kernel)

Handle the job.

Details

static PendingDispatch dispatch()

Dispatch the job with the given arguments.

Return Value

PendingDispatch

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

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

Parameters

$boolean
...$arguments

Return Value

PendingDispatch|Fluent

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

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

Parameters

$boolean
...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync()

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

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

Return Value

mixed

static mixed dispatchNow()

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

Return Value

mixed

static mixed dispatchAfterResponse()

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

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 for the job.

Parameters

DateTimeInterface|DateInterval|int|null $delay

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

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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Foundation/Console/QueuedCommand.html