class QueueableJob extends Job (View source)

Properties

protected int $jQueueBatchSize
protected Queue $jQueueObject

Methods

mixed
start(Queue $q)

Start processing a queue Typically this is where you would inject new messages into the queue

mixed
finish(Queue $q)

Finish processing a queue

void
processQueueItem(Message $msg)

Process a QueueMessage

__construct()

QueueableJob constructor.

run()

This is disabled since we don't want users to accidentally run a queable job without knowing it

int
getJobQueueBatchSize()

Get the size of the queue batches

Queue
getQueueObject()

Get the queue object we're going to use to queue

reset()

Delete the queue

markStarted()

Mark the queue as started

markCompleted(int $code, bool $message = false)

Mark the queue as having completed

executeJob()

Executejob for queueable jobs actually starts the queue, runs, and ends all in one function. This happens if we run a job in legacy mode.

executeBatch(array|iterator $batch, Queue $queue)

Process a queue batch

Details

abstract mixed start(Queue $q)

Start processing a queue Typically this is where you would inject new messages into the queue

Parameters

Queue $q

Return Value

mixed

abstract mixed finish(Queue $q)

Finish processing a queue

Parameters

Queue $q

Return Value

mixed

abstract void processQueueItem(Message $msg)

Process a QueueMessage

Parameters

Message $msg

Return Value

void

__construct()

QueueableJob constructor.

This is here and empty since it'd be a BC break to remove it.

run()

This is disabled since we don't want users to accidentally run a queable job without knowing it

int getJobQueueBatchSize()

Get the size of the queue batches

Return Value

int

Queue getQueueObject()

Get the queue object we're going to use to queue

Return Value

Queue

reset()

Delete the queue

markStarted()

Mark the queue as started

JobResult markCompleted(int $code, bool $message = false)

Mark the queue as having completed

Parameters

int $code 0 for success, otherwise the exception error code
bool $message The message to show

Return Value

JobResult

executeJob()

Executejob for queueable jobs actually starts the queue, runs, and ends all in one function. This happens if we run a job in legacy mode.

executeBatch(array|iterator $batch, Queue $queue)

Process a queue batch

Parameters

array|iterator $batch
Queue $queue