Job
in
Table of Contents
- attempts() : int
- Get the number of times the job has been attempted.
- delete() : void
- Delete the job from the queue.
- failed() : void
- Process an exception that caused the job to fail.
- fire() : void
- Fire the job.
- getConnectionName() : string
- Get the name of the connection the job belongs to.
- getName() : string
- Get the name of the queued job class.
- getQueue() : string
- Get the name of the queue the job belongs to.
- getRawBody() : string
- Get the raw body string for the job.
- isDeleted() : bool
- Determine if the job has been deleted.
- isDeletedOrReleased() : bool
- Determine if the job has been deleted or released.
- maxTries() : int|null
- Get the number of times to attempt a job.
- release() : mixed
- Release the job back into the queue.
- resolveName() : string
- Get the resolved name of the queued job class.
- timeout() : int|null
- Get the number of seconds the job can run.
- timeoutAt() : int|null
- Get the timestamp indicating when the job should timeout.
Methods
attempts()
Get the number of times the job has been attempted.
public
attempts() : int
Return values
int —delete()
Delete the job from the queue.
public
delete() : void
Return values
void —failed()
Process an exception that caused the job to fail.
public
failed(Throwable $e) : void
Parameters
- $e : Throwable
Return values
void —fire()
Fire the job.
public
fire() : void
Return values
void —getConnectionName()
Get the name of the connection the job belongs to.
public
getConnectionName() : string
Return values
string —getName()
Get the name of the queued job class.
public
getName() : string
Return values
string —getQueue()
Get the name of the queue the job belongs to.
public
getQueue() : string
Return values
string —getRawBody()
Get the raw body string for the job.
public
getRawBody() : string
Return values
string —isDeleted()
Determine if the job has been deleted.
public
isDeleted() : bool
Return values
bool —isDeletedOrReleased()
Determine if the job has been deleted or released.
public
isDeletedOrReleased() : bool
Return values
bool —maxTries()
Get the number of times to attempt a job.
public
maxTries() : int|null
Return values
int|null —release()
Release the job back into the queue.
public
release(int $delay) : mixed
Parameters
- $delay : int
Return values
mixed —resolveName()
Get the resolved name of the queued job class.
public
resolveName() : string
Resolves the name of "wrapped" jobs such as class-based handlers.
Return values
string —timeout()
Get the number of seconds the job can run.
public
timeout() : int|null
Return values
int|null —timeoutAt()
Get the timestamp indicating when the job should timeout.
public
timeoutAt() : int|null