1. class
  2. Illuminate
  3. \
  4. Queue
  5. \
  6. Jobs
  7. \
  8. Job

Job

abstract class Job (View source)

Traits

InteractsWithTime

Properties

protected mixed $instance

The job handler instance.
protected Container $container

The IoC container instance.
protected bool $deleted

Indicates if the job has been deleted.
protected bool $released

Indicates if the job has been released.
protected bool $failed

Indicates if the job has failed.
protected string $connectionName

The name of the connection the job belongs to.
protected string $queue

The name of the queue the job belongs to.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
string
getJobId()

Get the job identifier.

string
getRawBody()

Get the raw body of the job.

string|null
uuid()

Get the UUID of the job.

void
fire()

Fire the job.

void
delete()

Delete the job from the queue.

bool
isDeleted()

Determine if the job has been deleted.

void
release(int $delay = 0)

Release the job back into the queue after (n) seconds.

bool
isReleased()

Determine if the job was released back into the queue.

bool
isDeletedOrReleased()

Determine if the job has been deleted or released.

bool
hasFailed()

Determine if the job has been marked as a failure.

void
markAsFailed()

Mark the job as "failed".

void
fail(Throwable|null $e = null)

Delete the job, call the "failed" method, and raise the failed job event.

bool
shouldRollBackDatabaseTransaction(Throwable $e)

Determine if the current database transaction should be rolled back to level zero.

void
failed(Throwable|null $e)

Process an exception that caused the job to fail.

mixed
resolve(string $class)

Resolve the given class.

mixed
getResolvedJob()

Get the resolved job handler instance.

array
payload()

Get the decoded body of the job.

int|null
maxTries()

Get the number of times to attempt a job.

int|null
maxExceptions()

Get the number of times to attempt a job after an exception.

bool
shouldFailOnTimeout()

Determine if the job should fail when it timeouts.

int|int[]|null
backoff()

The number of seconds to wait before retrying a job that encountered an uncaught exception.

int|null
timeout()

Get the number of seconds the job can run.

int|null
retryUntil()

Get the timestamp indicating when the job should timeout.

string
getName()

Get the name of the queued job class.

string
resolveName()

Get the resolved display name of the queued job class.

string
resolveQueuedJobClass()

Get the class of the queued job.

string
getConnectionName()

Get the name of the connection the job belongs to.

string
getQueue()

Get the name of the queue the job belongs to.

Container
getContainer()

Get the service container instance.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

at line 72
abstract string getJobId()

Get the job identifier.

Return Value

string

at line 79
abstract string getRawBody()

Get the raw body of the job.

Return Value

string

at line 86
string|null uuid()

Get the UUID of the job.

Return Value

string|null

at line 96
void fire()

Fire the job.

Return Value

void

at line 110
void delete()

Delete the job from the queue.

Return Value

void

at line 120
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

at line 131
void release(int $delay = 0)

Release the job back into the queue after (n) seconds.

Parameters

int $delay

Return Value

void

at line 141
bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

at line 151
bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

at line 161
bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

at line 171
void markAsFailed()

Mark the job as "failed".

Return Value

void

at line 182
void fail(Throwable|null $e = null)

Delete the job, call the "failed" method, and raise the failed job event.

Parameters

Throwable|null $e

Return Value

void

at line 233
protected bool shouldRollBackDatabaseTransaction(Throwable $e)

Determine if the current database transaction should be rolled back to level zero.

Parameters

Throwable $e

Return Value

bool

at line 247
protected void failed(Throwable|null $e)

Process an exception that caused the job to fail.

Parameters

Throwable|null $e

Return Value

void

at line 264
protected mixed resolve(string $class)

Resolve the given class.

Parameters

string $class

Return Value

mixed

at line 274
mixed getResolvedJob()

Get the resolved job handler instance.

Return Value

mixed

at line 284
array payload()

Get the decoded body of the job.

Return Value

array

at line 294
int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

at line 304
int|null maxExceptions()

Get the number of times to attempt a job after an exception.

Return Value

int|null

at line 314
bool shouldFailOnTimeout()

Determine if the job should fail when it timeouts.

Return Value

bool

at line 324
int|int[]|null backoff()

The number of seconds to wait before retrying a job that encountered an uncaught exception.

Return Value

int|int[]|null

at line 334
int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

at line 344
int|null retryUntil()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

at line 354
string getName()

Get the name of the queued job class.

Return Value

string

at line 366
string resolveName()

Get the resolved display name of the queued job class.

Resolves the name of "wrapped" jobs such as class-based handlers.

Return Value

string

at line 378
string resolveQueuedJobClass()

Get the class of the queued job.

Resolves the class of "wrapped" jobs such as class-based handlers.

Return Value

string

at line 388
string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

at line 398
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

at line 408
Container getContainer()

Get the service container instance.

Return Value

Container