1. interface
  2. Core
  3. \
  4. Lib
  5. \
  6. Queue
  7. \
  8. QueueableJobInterface

QueueableJobInterface

interface QueueableJobInterface

Interface that all queueable jobs must implement.

Methods

int|array
backoff()

Sets backoff for a job

int
delay()

Sets delay for a job.

void
handle()

The logic that should be executed when the job is processed.

int
maxAttempts()

Undocumented function

array
toPayload()

Converts the job into a payload array for storage in the queue.

Details

at line 16
int|array backoff()

Sets backoff for a job

Return Value

int|array

The backoff value(s)

at line 23
int delay()

Sets delay for a job.

Return Value

int

The time for delay in seconds or Unix timestamp.

at line 30
void handle()

The logic that should be executed when the job is processed.

Return Value

void

at line 37
int maxAttempts()

Undocumented function

Return Value

int

at line 45
array toPayload()

Converts the job into a payload array for storage in the queue.

Must include the fully qualified class name and job data.

Return Value

array