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

RedisJob

class RedisJob extends Job (View source)

Properties

protected mixed $instance

The job handler instance.

 from  Job
protected Container $container

The IoC container instance.

 from  Job
protected string $queue

The name of the queue the job belongs to.

 from  Job
protected bool $deleted

Indicates if the job has been deleted.

 from  Job
protected RedisQueue $redis

The Redis queue instance.
protected string $job

The Redis job payload.

Methods

void
fire()

Fire the job.

void
delete()

Delete the job from the queue.

bool
isDeleted()

Determine if the job has been deleted.

from  Job
void
release(int $delay = 0)

Release the job back into the queue.

int
attempts()

Get the number of times the job has been attempted.

string
getRawBody()

Get the raw body string for the job.

void
resolveAndFire(array $payload)

Resolve and fire the job handler method.

from  Job
mixed
resolve(string $class)

Resolve the given job handler.

from  Job
array
parseJob(string $job)

Parse the job declaration into class and method.

from  Job
bool
autoDelete()

Determine if job should be auto-deleted.

from  Job
int
getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

from  Job
int
getTime()

Get the current system time.

from  Job
string
getName()

Get the name of the queued job class.

from  Job
string
getQueue()

Get the name of the queue the job belongs to.

from  Job
void
__construct(Container $container, RedisQueue $redis, string $job, string $queue)

Create a new job instance.

string
getJobId()

Get the job identifier.

Container
getContainer()

Get the IoC container instance.

Database
getRedisQueue()

Get the underlying queue driver instance.

string
getRedisJob()

Get the underlying Redis job.

Details

at line 44
void fire()

Fire the job.

Return Value

void

at line 64
void delete()

Delete the job from the queue.

Return Value

void

in Job at line 57
bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

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

Release the job back into the queue.

Parameters

int $delay

Return Value

void

at line 89
int attempts()

Get the number of times the job has been attempted.

Return Value

int

at line 54
string getRawBody()

Get the raw body string for the job.

Return Value

string

in Job at line 90
protected void resolveAndFire(array $payload)

Resolve and fire the job handler method.

Parameters

array $payload

Return Value

void

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

Resolve the given job handler.

Parameters

string $class

Return Value

mixed

in Job at line 116
protected array parseJob(string $job)

Parse the job declaration into class and method.

Parameters

string $job

Return Value

array

in Job at line 128
bool autoDelete()

Determine if job should be auto-deleted.

Return Value

bool

in Job at line 139
protected int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

Parameters

DateTime|int $delay

Return Value

int

in Job at line 154
protected int getTime()

Get the current system time.

Return Value

int

in Job at line 164
string getName()

Get the name of the queued job class.

Return Value

string

in Job at line 174
string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

at line 31
void __construct(Container $container, RedisQueue $redis, string $job, string $queue)

Create a new job instance.

Parameters

Container $container
RedisQueue $redis
string $job
string $queue

Return Value

void

at line 99
string getJobId()

Get the job identifier.

Return Value

string

at line 109
Container getContainer()

Get the IoC container instance.

Return Value

Container

at line 119
Database getRedisQueue()

Get the underlying queue driver instance.

Return Value

Database

at line 129
string getRedisJob()

Get the underlying Redis job.

Return Value

string