abstract class Job (View source)

Traits

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.

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

Get the "available at" UNIX timestamp.

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

int
currentTime()

Get the current system time as a UNIX timestamp.

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

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

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.

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 name of the queued job class.

string
getConnectionName()

Get the name of the connection the job belongs to.

string
getQueue()

Get the name of the queue the job belongs to.

getContainer()

Get the service container instance.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

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

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

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

abstract string getJobId()

Get the job identifier.

Return Value

string

abstract string getRawBody()

Get the raw body of the job.

Return Value

string

string|null uuid()

Get the UUID of the job.

Return Value

string|null

void fire()

Fire the job.

Return Value

void

void delete()

Delete the job from the queue.

Return Value

void

bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

void release(int $delay = 0)

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

Parameters

int $delay

Return Value

void

bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

void markAsFailed()

Mark the job as "failed".

Return Value

void

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

protected void failed(Throwable|null $e)

Process an exception that caused the job to fail.

Parameters

Throwable|null $e

Return Value

void

protected mixed resolve(string $class)

Resolve the given class.

Parameters

string $class

Return Value

mixed

mixed getResolvedJob()

Get the resolved job handler instance.

Return Value

mixed

array payload()

Get the decoded body of the job.

Return Value

array

int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

int|null maxExceptions()

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

Return Value

int|null

bool shouldFailOnTimeout()

Determine if the job should fail when it timeouts.

Return Value

bool

int|int[]|null backoff()

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

Return Value

int|int[]|null

int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

int|null retryUntil()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

string getName()

Get the name of the queued job class.

Return Value

string

string resolveName()

Get the resolved name of the queued job class.

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

Return Value

string

string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

Container getContainer()

Get the service container instance.

Return Value

Container