Job
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
Get the number of seconds until the given DateTime.
If the given value is an interval, convert it to a DateTime instance.
Given a start time, format the total run time for human readability.
Get the job identifier.
Get the raw body of the job.
Get the UUID of the job.
Fire the job.
Delete the job from the queue.
Determine if the job has been deleted.
Release the job back into the queue after (n) seconds.
Determine if the job was released back into the queue.
Determine if the job has been deleted or released.
Determine if the job has been marked as a failure.
Mark the job as "failed".
Resolve the given class.
Get the resolved job handler instance.
Get the decoded body of the job.
Get the number of times to attempt a job.
Get the number of times to attempt a job after an exception.
Determine if the job should fail when it timeouts.
The number of seconds to wait before retrying a job that encountered an uncaught exception.
Get the number of seconds the job can run.
Get the timestamp indicating when the job should timeout.
Get the name of the queued job class.
Get the resolved name of the queued job class.
Get the name of the connection the job belongs to.
Get the name of the queue the job belongs to.
Get the service container instance.
Details
protected int
secondsUntil(DateTimeInterface|DateInterval|int $delay)
Get the number of seconds until the given DateTime.
protected int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Get the "available at" UNIX timestamp.
protected DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)
If the given value is an interval, convert it to a DateTime instance.
protected int
currentTime()
Get the current system time as a UNIX timestamp.
protected string
runTimeForHumans(float $startTime, float $endTime = null)
Given a start time, format the total run time for human readability.
abstract string
getJobId()
Get the job identifier.
abstract 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.
protected void
failed(Throwable|null $e)
Process an exception that caused the job to fail.
protected 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.
Resolves the name of "wrapped" jobs such as class-based handlers.
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.