Job

class Job (View source)

Properties

protected mixed $instance The job handler instance.
protected Container $container The IoC container instance.
protected string $queue The name of the queue the job belongs to.
protected bool $deleted Indicates if the job has been deleted.
protected bool $released Indicates if the job has been released.

Methods

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)

Release the job back into the queue.
bool isReleased()

Determine if the job was released back into the queue.
bool isDeletedOrReleased()

Determine if the job has been deleted or released.
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.
array parseJob(string $job)

Parse the job declaration into class and method.
mixed resolve(string $class)

Resolve the given job handler.
mixed resolveQueueableEntities(mixed $data)

Resolve all of the queueable entities in the given payload.
QueueableEntity resolveQueueableEntity(mixed $value)

Resolve a single queueable entity from the resolver.
void failed()

Call the failed method on the job instance.
EntityResolver getEntityResolver()

Get an entity resolver instance.
int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.
int getTime()

Get the current system time.
string getName()

Get the name of the queued job class.
string getQueue()

Get the name of the queue the job belongs to.

Details

abstract void fire()

Fire the job.

Return Value

void

void delete()

Delete the job from the queue.

Return Value

void

bool isDeleted()

Determine if the job has been deleted.

Return Value

bool

void release(int $delay)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

bool isReleased()

Determine if the job was released back into the queue.

Return Value

bool

bool isDeletedOrReleased()

Determine if the job has been deleted or released.

Return Value

bool

abstract int attempts()

Get the number of times the job has been attempted.

Return Value

int

abstract string getRawBody()

Get the raw body string for the job.

Return Value

string

protected void resolveAndFire(array $payload)

Resolve and fire the job handler method.

Parameters

array $payload

Return Value

void

protected array parseJob(string $job)

Parse the job declaration into class and method.

Parameters

string $job

Return Value

array

protected mixed resolve(string $class)

Resolve the given job handler.

Parameters

string $class

Return Value

mixed

protected mixed resolveQueueableEntities(mixed $data)

Resolve all of the queueable entities in the given payload.

Parameters

mixed $data

Return Value

mixed

protected QueueableEntity resolveQueueableEntity(mixed $value)

Resolve a single queueable entity from the resolver.

Parameters

mixed $value

Return Value

QueueableEntity

void failed()

Call the failed method on the job instance.

Return Value

void

protected EntityResolver getEntityResolver()

Get an entity resolver instance.

Return Value

EntityResolver

protected int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

Parameters

DateTime|int $delay

Return Value

int

protected int getTime()

Get the current system time.

Return Value

int

string getName()

Get the name of the queued job class.

Return Value

string

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Queue/Jobs/Job.html