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

SyncJob

class SyncJob extends Job implements Job (View source)

Traits

InteractsWithTime

Properties

protected mixed $instance

The job handler instance.

 from  Job
protected Container $container

The IoC container instance.

 from  Job
protected bool $deleted

Indicates if the job has been deleted.

 from  Job
protected bool $released

Indicates if the job has been released.

 from  Job
protected bool $failed

Indicates if the job has failed.

 from  Job
protected string $connectionName

The name of the connection the job belongs to.

 from  Job
protected string $queue

The name of the queue the job belongs to.

 from  Job
protected string $job

The class name of the job.
protected string $payload

The queue message data.

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
getJobId()

Get the job identifier.

string
getRawBody()

Get the raw body string for the job.

string|null
uuid()

Get the UUID of the job.

from  Job
void
fire()

Fire the job.

from  Job
void
delete()

Delete the job from the queue.

from  Job
bool
isDeleted()

Determine if the job has been deleted.

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

from  Job
bool
isDeletedOrReleased()

Determine if the job has been deleted or released.

from  Job
bool
hasFailed()

Determine if the job has been marked as a failure.

from  Job
void
markAsFailed()

Mark the job as "failed".

from  Job
void
fail(Throwable|null $e = null)

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

from  Job
void
failed(Throwable|null $e)

Process an exception that caused the job to fail.

from  Job
mixed
resolve(string $class)

Resolve the given class.

from  Job
mixed
getResolvedJob()

Get the resolved job handler instance.

from  Job
array
payload()

Get the decoded body of the job.

from  Job
int|null
maxTries()

Get the number of times to attempt a job.

from  Job
int|null
maxExceptions()

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

from  Job
bool
shouldFailOnTimeout()

Determine if the job should fail when it timeouts.

from  Job
int|int[]|null
backoff()

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

from  Job
int|null
timeout()

Get the number of seconds the job can run.

from  Job
int|null
retryUntil()

Get the timestamp indicating when the job should timeout.

from  Job
string
getName()

Get the name of the queued job class.

from  Job
string
resolveName()

Get the resolved name of the queued job class.

from  Job
string
getConnectionName()

Get the name of the connection the job belongs to.

from  Job
string
getQueue()

Get the name of the queue the job belongs to.

Container
getContainer()

Get the service container instance.

from  Job
void
__construct(Container $container, string $payload, string $connectionName, string $queue)

Create a new job instance.

int
attempts()

Get the number of times the job has been attempted.

Details

in InteractsWithTime at line 16
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 31
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 46
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 60
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

at line 67
string getJobId()

Get the job identifier.

Return Value

string

at line 77
string getRawBody()

Get the raw body string for the job.

Return Value

string

in Job at line 86
string|null uuid()

Get the UUID of the job.

Return Value

string|null

in Job at line 96
void fire()

Fire the job.

Return Value

void

in Job at line 110
void delete()

Delete the job from the queue.

Return Value

void

in Job at line 120
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

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

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

Parameters

int $delay

Return Value

void

in Job at line 141
bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

in Job at line 151
bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

in Job at line 161
bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

in Job at line 171
void markAsFailed()

Mark the job as "failed".

Return Value

void

in Job 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

in Job at line 229
protected void failed(Throwable|null $e)

Process an exception that caused the job to fail.

Parameters

Throwable|null $e

Return Value

void

in Job at line 246
protected mixed resolve(string $class)

Resolve the given class.

Parameters

string $class

Return Value

mixed

in Job at line 256
mixed getResolvedJob()

Get the resolved job handler instance.

Return Value

mixed

in Job at line 266
array payload()

Get the decoded body of the job.

Return Value

array

in Job at line 276
int|null maxTries()

Get the number of times to attempt a job.

Return Value

int|null

in Job at line 286
int|null maxExceptions()

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

Return Value

int|null

in Job at line 296
bool shouldFailOnTimeout()

Determine if the job should fail when it timeouts.

Return Value

bool

in Job at line 306
int|int[]|null backoff()

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

Return Value

int|int[]|null

in Job at line 316
int|null timeout()

Get the number of seconds the job can run.

Return Value

int|null

in Job at line 326
int|null retryUntil()

Get the timestamp indicating when the job should timeout.

Return Value

int|null

in Job at line 336
string getName()

Get the name of the queued job class.

Return Value

string

in Job at line 348
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

in Job at line 358
string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

at line 87
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

in Job at line 378
Container getContainer()

Get the service container instance.

Return Value

Container

at line 33
void __construct(Container $container, string $payload, string $connectionName, string $queue)

Create a new job instance.

Parameters

Container $container
string $payload
string $connectionName
string $queue

Return Value

void

at line 57
int attempts()

Get the number of times the job has been attempted.

Return Value

int