StudioBonito\SilverStripe\Queue\Jobs\SyncJob
Synopsis
class SyncJob
extends AbstractJob
{
- // Inherited members from AbstractJob
- protected Injector $injector;
- protected $instance;
- protected $queue;
- protected bool $deleted;
- // methods
- public void __construct()
- public void run()
- public string getRawPayload()
- public void delete()
- public void release()
- public int attempts()
- public string getJobId()
- // Inherited methods from AbstractJob
- public abstract void run()
- public void delete()
- public bool isDeleted()
- public abstract void release()
- public abstract int attempts()
- public abstract string getRawPayload()
- protected void resolveAndRun()
- protected mixed resolve()
- protected array parseJob()
- public bool autoDelete()
- protected int getSeconds()
- public int getTime()
- public string getQueue()
Hierarchy
Members
protected
- $data
—
string
The queue message data. - $deleted
—
StudioBonito\SilverStripe\Queue\Jobs\bool
Indicates if the job has been deleted. - $injector
—
\Injector
The injector instance. - $instance — mixed
- $job
—
string
The class name of the job. - $queue — string
Methods
public
- __construct() — Create a new job instance.
- attempts() — Get the number of times the job has been attempted.
- delete() — Delete the job from the queue.
- getJobId() — Get the job identifier.
- getRawPayload() — Get the raw body string for the job.
- release() — Release the job back into the queue.
- run() — Run the job.
Inherited from StudioBonito\SilverStripe\Queue\Jobs\AbstractJob
protected
- getSeconds() — Calculate the number of seconds with the given delay.
- parseJob() — Parse the job declaration into class and method.
- resolve() — Resolve the given job handler.
- resolveAndRun() — Resolve and fire the job handler method.
public
- attempts() — Get the number of times the job has been attempted.
- autoDelete() — Determine if job should be auto-deleted.
- delete() — Delete the job from the queue.
- getQueue() — Get the name of the queue the job belongs to.
- getRawPayload() — Get the raw payload string for the job.
- getTime() — Get the current UNIX timestamp.
- isDeleted() — Determine if the job has been deleted.
- release() — Release the job back into the queue.
- run() — Run the job.