Documentation

QueuedCommand
in package

Application

implements ShouldQueue Uses Dispatchable, Queueable

Interfaces, Classes and Traits

ShouldQueue

$chainConnection : string|null: The name of the connection the chain should be sent to.
$chained : array<string|int, mixed>: The jobs that should run if this job is successful.
$chainQueue : string|null: The name of the queue the chain should be sent to.
$connection : string|null: The name of the connection the job should be sent to.
$delay : DateTimeInterface|DateInterval|int|null: The number of seconds before the job should be made available.
$queue : string|null: The name of the queue the job should be sent to.
$data : array<string|int, mixed>: The data to pass to the Artisan command.
__construct() : void: Create a new job instance.
allOnConnection() : $this: Set the desired connection for the chain.
allOnQueue() : $this: Set the desired queue for the chain.
chain() : $this: Set the jobs that should run if this job is successful.
delay() : $this: Set the desired delay for the job.
dispatch() : PendingDispatch: Dispatch the job with the given arguments.
dispatchNextJobInChain() : void: Dispatch the next job on the chain.
handle() : void: Handle the job.
onConnection() : $this: Set the desired connection for the job.
onQueue() : $this: Set the desired queue for the job.
withChain() : PendingChain: Set the jobs that should run if this job is successful.

$chainConnection

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


    public
        string|null
    $chainConnection

$chained

The jobs that should run if this job is successful.


    public
        array<string|int, mixed>
    $chained
     = []

$chainQueue

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


    public
        string|null
    $chainQueue

$connection

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


    public
        string|null
    $connection

$delay

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


    public
        DateTimeInterface|DateInterval|int|null
    $delay

$queue

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


    public
        string|null
    $queue

$data

The data to pass to the Artisan command.


    protected
        array<string|int, mixed>
    $data

__construct()

Create a new job instance.


    public
                __construct(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

Return values

void —

allOnConnection()

Set the desired connection for the chain.


    public
                allOnConnection(string|null $connection) : $this

Parameters

$connection : string|null

Return values

$this —

allOnQueue()

Set the desired queue for the chain.


    public
                allOnQueue(string|null $queue) : $this

Parameters

$queue : string|null

Return values

$this —

chain()

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


    public
                chain(array<string|int, mixed> $chain) : $this

Parameters

$chain : array<string|int, mixed>

Return values

$this —

delay()

Set the desired delay for the job.


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

Parameters

$delay : DateTimeInterface|DateInterval|int|null

Return values

$this —

dispatch()

Dispatch the job with the given arguments.


    public
            static    dispatch() : PendingDispatch

Return values

PendingDispatch —

dispatchNextJobInChain()

Dispatch the next job on the chain.


    public
                dispatchNextJobInChain() : void

Return values

void —

handle()

Handle the job.


    public
                handle(Kernel $kernel) : void

Parameters

$kernel : Kernel

Return values

void —

onConnection()

Set the desired connection for the job.


    public
                onConnection(string|null $connection) : $this

Parameters

$connection : string|null

Return values

$this —

onQueue()

Set the desired queue for the job.


    public
                onQueue(string|null $queue) : $this

Parameters

$queue : string|null

Return values

$this —

withChain()

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


    public
            static    withChain(array<string|int, mixed> $chain) : PendingChain

Parameters

$chain : array<string|int, mixed>

Return values

PendingChain —