IronJob
class IronJob extends Job implements Job (View source)
Properties
protected mixed | $instance | The job handler instance. | from Job |
protected Container | $container | The IoC container instance. | from Job |
protected string | $queue | The name of the queue the job belongs to. | from Job |
protected bool | $deleted | Indicates if the job has been deleted. | from Job |
protected bool | $released | Indicates if the job has been released. | from Job |
protected IronQueue | $iron | The Iron queue instance. | |
protected object | $job | The IronMQ message instance. | |
protected bool | $pushed | Indicates if the message was a push message. |
Methods
void | fire() Fire the 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 |
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. | from Job |
array | parseJob(string $job) Parse the job declaration into class and method. | from Job |
mixed | resolve(string $class) Resolve the given job handler. | from Job |
mixed | resolveQueueableEntities(mixed $data) Resolve all of the queueable entities in the given payload. | from Job |
QueueableEntity | resolveQueueableEntity(mixed $value) Resolve a single queueable entity from the resolver. | from Job |
void | failed() Call the failed method on the job instance. | from Job |
EntityResolver | getEntityResolver() Get an entity resolver instance. | from Job |
int | getSeconds(DateTime|int $delay) Calculate the number of seconds with the given delay. | from Job |
int | getTime() Get the current system time. | from Job |
string | getName() Get the name of the queued job class. | from Job |
string | getQueue() Get the name of the queue the job belongs to. | |
void | __construct(Container $container, IronQueue $iron, object $job, bool $pushed = false) Create a new job instance. | |
void | recreateJob(int $delay) Release a pushed job back onto the queue. | |
string | getJobId() Get the job identifier. | |
Container | getContainer() Get the IoC container instance. | |
IronQueue | getIron() Get the underlying Iron queue instance. | |
array | getIronJob() Get the underlying IronMQ job. |
Details
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.
protected void resolveAndFire(array $payload)
Resolve and fire the job handler method.
protected array parseJob(string $job)
Parse the job declaration into class and method.
protected mixed resolve(string $class)
Resolve the given job handler.
protected mixed resolveQueueableEntities(mixed $data)
Resolve all of the queueable entities in the given payload.
protected QueueableEntity resolveQueueableEntity(mixed $value)
Resolve a single queueable entity from the resolver.
void failed()
Call the failed method on the job instance.
protected EntityResolver getEntityResolver()
Get an entity resolver instance.
protected int getSeconds(DateTime|int $delay)
Calculate the number of seconds with the given delay.
protected 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.
void __construct(Container $container, IronQueue $iron, object $job, bool $pushed = false)
Create a new job instance.
protected void recreateJob(int $delay)
Release a pushed job back onto the queue.
string getJobId()
Get the job identifier.
Container getContainer()
Get the IoC container instance.
IronQueue getIron()
Get the underlying Iron queue instance.
array getIronJob()
Get the underlying IronMQ job.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Queue/Jobs/IronJob.html