W3cubDocs

/Laravel 5.4

DatabaseJob

class DatabaseJob extends Job implements Job (View source)

Traits

InteractsWithTime

Methods

void fire()

Fire the job.

from Job
void delete()

Delete the job from the queue.

bool isDeleted()

Determine if the job has been deleted.

from Job
void release(int $delay)

Release the job back into the queue.

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 failed(Exception $e)

Process an exception that caused the job to fail.

from Job
array payload()

Get the decoded body of the job.

from Job
int|null maxTries()

The number of times to attempt a job.

from Job
int|null timeout()

The number of seconds the job can run.

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.

from Job
Container getContainer()

Get the service container instance.

from Job
void __construct(Container $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue)

Create a new job instance.

int attempts()

Get the number of times the job has been attempted.

string getJobId()

Get the job identifier.

string getRawBody()

Get the raw body string for the job.

Details

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

bool hasFailed()

Determine if the job has been marked as a failure.

Return Value

bool

void markAsFailed()

Mark the job as "failed".

Return Value

void

void failed(Exception $e)

Process an exception that caused the job to fail.

Parameters

Exception $e

Return Value

void

array payload()

Get the decoded body of the job.

Return Value

array

int|null maxTries()

The number of times to attempt a job.

Return Value

int|null

int|null timeout()

The number of seconds the job can run.

Return Value

int|null

string getName()

Get the name of the queued job class.

Return Value

string

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

string getConnectionName()

Get the name of the connection the job belongs to.

Return Value

string

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

void __construct(Container $container, DatabaseQueue $database, stdClass $job, string $connectionName, string $queue)

Create a new job instance.

Parameters

Container $container
DatabaseQueue $database
stdClass $job
string $connectionName
string $queue

Return Value

void

int attempts()

Get the number of times the job has been attempted.

Return Value

int

string getJobId()

Get the job identifier.

Return Value

string

string getRawBody()

Get the raw body string for the job.

Return Value

string

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