1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Queue
  7. \
  8. Job

Job

interface Job

Methods

string|null
uuid()

Get the UUID of the job.

int|string|null
getJobId()

Get the job identifier.

array
payload()

Get the decoded body of the job.

void
fire()

Fire the job.

void
release(int $delay = 0)

Release the job back into the queue after the specified delay.

bool
isReleased()

Determine if the job was released back into the queue.

void
delete()

Delete the job from the queue.

bool
isDeleted()

Determine if the job has been deleted.

bool
isDeletedOrReleased()

Determine if the job has been deleted or released.

int
attempts()

Get the number of times the job has been attempted.

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.

int|null
maxTries()

Get the number of times to attempt a job.

int|null
maxExceptions()

Get the maximum number of exceptions allowed, regardless of attempts.

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
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.

string
getRawBody()

Get the raw body string for the job.

Details

at line 14
string|null uuid()

Get the UUID of the job.

Return Value

string|null

at line 19
int|string|null getJobId()

Get the job identifier.

Return Value

int|string|null

at line 26
array payload()

Get the decoded body of the job.

Return Value

array

at line 31
void fire()

Fire the job.

Return Value

void

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

Release the job back into the queue after the specified delay.

Parameters

int $delay

Return Value

void

at line 41
bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

at line 46
void delete()

Delete the job from the queue.

Return Value

void

at line 51
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

at line 56
bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

at line 61
int attempts()

Get the number of times the job has been attempted.

Return Value

int

at line 66
bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

at line 71
void markAsFailed()

Mark the job as "failed".

Return Value

void

at line 76
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 81
int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

at line 86
int|null maxExceptions()

Get the maximum number of exceptions allowed, regardless of attempts.

Return Value

int|null

at line 91
int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

at line 96
int|null retryUntil()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

at line 101
string getName()

Get the name of the queued job class.

Return Value

string

at line 106
string resolveName()

Get the resolved name of the queued job class.

Return Value

string

at line 111
string resolveQueuedJobClass()

Get the class of the queued job.

Return Value

string

at line 116
string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

at line 121
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

at line 126
string getRawBody()

Get the raw body string for the job.

Return Value

string