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.

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.
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.
mixed resolve(string $class)

Resolve the given job handler.
array parseJob(string $job)

Parse the job declaration into class and method.
bool autoDelete()

Determine if job should be auto-deleted.
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

abstract void release(int $delay)

Release the job back into the queue.

Parameters

int $delay

Return Value

void

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 mixed resolve(string $class)

Resolve the given job handler.

Parameters

string $class

Return Value

mixed

protected array parseJob(string $job)

Parse the job declaration into class and method.

Parameters

string $job

Return Value

array

bool autoDelete()

Determine if job should be auto-deleted.

Return Value

bool

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/4.2/Illuminate/Queue/Jobs/Job.html