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

int attempts()

Get the number of times the job has been attempted.
string getRawBody()

Get the raw body string for the job.
void fire()

Fire the job.
mixed resolve(string $class)

Resolve the given job handler.
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.
void failed(Exception $e)

Call the failed method on the job instance.
array parseJob(string $job)

Parse the job declaration into class and method.
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 resolveName()

Get the resolved name of the queued job class.
array payload()

Get the decoded body of the job.
string getQueue()

Get the name of the queue the job belongs to.
Container getContainer()

Get the service container instance.

Details

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

void fire()

Fire the job.

Return Value

void

protected mixed resolve(string $class)

Resolve the given job handler.

Parameters

string $class

Return Value

mixed

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

void failed(Exception $e)

Call the failed method on the job instance.

Parameters

Exception $e

Return Value

void

protected array parseJob(string $job)

Parse the job declaration into class and method.

Parameters

string $job

Return Value

array

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

Get the resolved name of the queued job class.

Return Value

string

array payload()

Get the decoded body of the job.

Return Value

array

string getQueue()

Get the name of the queue the job belongs to.

Return Value

string

Container getContainer()

Get the service container instance.

Return Value

Container

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