Job.php
TLDR
The Job.php file is a class file in the Illuminate\Queue\Jobs namespace. It provides a base class for representing jobs in a queue system. The class contains various methods for handling job execution, failure, deletion, releasing, and metadata retrieval.
Methods
getJobId()
Gets the job identifier.
getRawBody()
Gets the raw body of the job.
uuid()
Gets the UUID of the job.
fire()
Executes the job.
delete()
Deletes the job from the queue.
isDeleted()
Determines if the job has been deleted.
release($delay = 0)
Releases the job back into the queue after a specified delay.
isReleased()
Determines if the job was released back into the queue.
isDeletedOrReleased()
Determines if the job has been deleted or released.
hasFailed()
Determines if the job has been marked as a failure.
markAsFailed()
Marks the job as "failed".
fail($e = null)
Deletes the job, calls the "failed" method, and raises the failed job event.
failed($e)
Processes an exception that caused the job to fail.
resolve($class)
Resolves the given class.
getResolvedJob()
Gets the resolved job handler instance.
payload()
Gets the decoded body of the job.
maxTries()
Gets the number of times to attempt a job.
maxExceptions()
Gets the number of times to attempt a job after an exception.
shouldFailOnTimeout()
Determines if the job should fail when it timeouts.
backoff()
Gets the number of seconds to wait before retrying a job.
timeout()
Gets the number of seconds the job can run.
retryUntil()
Gets the timestamp indicating when the job should timeout.
getName()
Gets the name of the queued job class.
resolveName()
Gets the resolved name of the queued job class.
getConnectionName()
Gets the name of the connection the job belongs to.
getQueue()
Gets the name of the queue the job belongs to.
getContainer()
Gets the service container instance.
Classes
None
<?php
namespace Illuminate\Queue\Jobs;
use Illuminate\Bus\Batchable;
use Illuminate\Bus\BatchRepository;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Queue\Events\JobFailed;
use Illuminate\Queue\ManuallyFailedException;
use Illuminate\Queue\TimeoutExceededException;
use Illuminate\Support\InteractsWithTime;
use Throwable;
abstract class Job
{
use InteractsWithTime;
/**
* The job handler instance.
*
* @var mixed
*/
protected $instance;
/**
* The IoC container instance.
*
* @var \Illuminate\Container\Container
*/
protected $container;
/**
* Indicates if the job has been deleted.
*
* @var bool
*/
protected $deleted = false;
/**
* Indicates if the job has been released.
*
* @var bool
*/
protected $released = false;
/**
* Indicates if the job has failed.
*
* @var bool
*/
protected $failed = false;
/**
* The name of the connection the job belongs to.
*
* @var string
*/
protected $connectionName;
/**
* The name of the queue the job belongs to.
*
* @var string
*/
protected $queue;
/**
* Get the job identifier.
*
* @return string
*/
abstract public function getJobId();
/**
* Get the raw body of the job.
*
* @return string
*/
abstract public function getRawBody();
/**
* Get the UUID of the job.
*
* @return string|null
*/
public function uuid()
{
return $this->payload()['uuid'] ?? null;
}
/**
* Fire the job.
*
* @return void
*/
public function fire()
{
$payload = $this->payload();
[$class, $method] = JobName::parse($payload['job']);
($this->instance = $this->resolve($class))->{$method}($this, $payload['data']);
}
/**
* Delete the job from the queue.
*
* @return void
*/
public function delete()
{
$this->deleted = true;
}
/**
* Determine if the job has been deleted.
*
* @return bool
*/
public function isDeleted()
{
return $this->deleted;
}
/**
* Release the job back into the queue after (n) seconds.
*
* @param int $delay
* @return void
*/
public function release($delay = 0)
{
$this->released = true;
}
/**
* Determine if the job was released back into the queue.
*
* @return bool
*/
public function isReleased()
{
return $this->released;
}
/**
* Determine if the job has been deleted or released.
*
* @return bool
*/
public function isDeletedOrReleased()
{
return $this->isDeleted() || $this->isReleased();
}
/**
* Determine if the job has been marked as a failure.
*
* @return bool
*/
public function hasFailed()
{
return $this->failed;
}
/**
* Mark the job as "failed".
*
* @return void
*/
public function markAsFailed()
{
$this->failed = true;
}
/**
* Delete the job, call the "failed" method, and raise the failed job event.
*
* @param \Throwable|null $e
* @return void
*/
public function fail($e = null)
{
$this->markAsFailed();
if ($this->isDeleted()) {
return;
}
$commandName = $this->payload()['data']['commandName'] ?? false;
// If the exception is due to a job timing out, we need to rollback the current
// database transaction so that the failed job count can be incremented with
// the proper value. Otherwise, the current transaction will never commit.
if ($e instanceof TimeoutExceededException &&
$commandName &&
in_array(Batchable::class, class_uses_recursive($commandName))) {
$batchRepository = $this->resolve(BatchRepository::class);
try {
$batchRepository->rollBack();
} catch (Throwable $e) {
// ...
}
}
try {
// If the job has failed, we will delete it, call the "failed" method and then call
// an event indicating the job has failed so it can be logged if needed. This is
// to allow every developer to better keep monitor of their failed queue jobs.
$this->delete();
$this->failed($e);
} finally {
$this->resolve(Dispatcher::class)->dispatch(new JobFailed(
$this->connectionName, $this, $e ?: new ManuallyFailedException
));
}
}
/**
* Process an exception that caused the job to fail.
*
* @param \Throwable|null $e
* @return void
*/
protected function failed($e)
{
$payload = $this->payload();
[$class, $method] = JobName::parse($payload['job']);
if (method_exists($this->instance = $this->resolve($class), 'failed')) {
$this->instance->failed($payload['data'], $e, $payload['uuid'] ?? '');
}
}
/**
* Resolve the given class.
*
* @param string $class
* @return mixed
*/
protected function resolve($class)
{
return $this->container->make($class);
}
/**
* Get the resolved job handler instance.
*
* @return mixed
*/
public function getResolvedJob()
{
return $this->instance;
}
/**
* Get the decoded body of the job.
*
* @return array
*/
public function payload()
{
return json_decode($this->getRawBody(), true);
}
/**
* Get the number of times to attempt a job.
*
* @return int|null
*/
public function maxTries()
{
return $this->payload()['maxTries'] ?? null;
}
/**
* Get the number of times to attempt a job after an exception.
*
* @return int|null
*/
public function maxExceptions()
{
return $this->payload()['maxExceptions'] ?? null;
}
/**
* Determine if the job should fail when it timeouts.
*
* @return bool
*/
public function shouldFailOnTimeout()
{
return $this->payload()['failOnTimeout'] ?? false;
}
/**
* The number of seconds to wait before retrying a job that encountered an uncaught exception.
*
* @return int|int[]|null
*/
public function backoff()
{
return $this->payload()['backoff'] ?? $this->payload()['delay'] ?? null;
}
/**
* Get the number of seconds the job can run.
*
* @return int|null
*/
public function timeout()
{
return $this->payload()['timeout'] ?? null;
}
/**
* Get the timestamp indicating when the job should timeout.
*
* @return int|null
*/
public function retryUntil()
{
return $this->payload()['retryUntil'] ?? null;
}
/**
* Get the name of the queued job class.
*
* @return string
*/
public function getName()
{
return $this->payload()['job'];
}
/**
* Get the resolved name of the queued job class.
*
* Resolves the name of "wrapped" jobs such as class-based handlers.
*
* @return string
*/
public function resolveName()
{
return JobName::resolve($this->getName(), $this->payload());
}
/**
* Get the name of the connection the job belongs to.
*
* @return string
*/
public function getConnectionName()
{
return $this->connectionName;
}
/**
* Get the name of the queue the job belongs to.
*
* @return string
*/
public function getQueue()
{
return $this->queue;
}
/**
* Get the service container instance.
*
* @return \Illuminate\Container\Container
*/
public function getContainer()
{
return $this->container;
}
}