trait Illuminate / Bus / Queueable

Queueable

Properties

public

$connection string|null

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

Default: null
public

$queue string|null

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

Default: null
public

$chainConnection string|null

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

Default: null
public

$chainQueue string|null

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

Default: null
public

$chainCatchCallbacks array|null

The callbacks to be executed on chain failure.

Default: null
public

$delay DateTimeInterface |DateInterval |array|int|null

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

Default: null
public

$afterCommit bool|null

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

Default: null
public

$middleware array

The middleware the job should be dispatched through.

Default: []
public

$chained array

The jobs that should run if this job is successful.

Default: []

Methods

public

onConnection ( $connection ) : $this

Set the desired connection for the job.

Parameters

  • $connection string|null
public

onQueue ( $queue ) : $this

Set the desired queue for the job.

Parameters

  • $queue string|null
public

allOnConnection ( $connection ) : $this

Set the desired connection for the chain.

Parameters

  • $connection string|null
public

allOnQueue ( $queue ) : $this

Set the desired queue for the chain.

Parameters

  • $queue string|null
public

delay ( $delay ) : $this

Set the desired delay in seconds for the job.

Parameters

public

afterCommit ( ) : $this

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

public

beforeCommit ( ) : $this

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

public

through ( $middleware ) : $this

Specify the middleware the job should be dispatched through.

Parameters

  • $middleware array|object
public

chain ( $chain ) : $this

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

Parameters

  • $chain array
public

prependToChain ( $job ) : $this

Prepend a job to the current chain so that it is run after the currently running job.

Parameters

  • $job mixed
public

appendToChain ( $job ) : $this

Append a job to the end of the current chain.

Parameters

  • $job mixed
protected

serializeJob ( $job ) : string

Serialize a job for queuing.

Parameters

  • $job mixed
public

dispatchNextJobInChain ( ) : void

Dispatch the next job on the chain.

public

invokeChainCatchCallbacks ( $e ) : void

Invoke all of the chain's failed job callbacks.

Parameters