Symbiote\QueuedJobs\Jobs\CleanupJob
An queued job to clean out the QueuedJobDescriptor Table which often gets too full
- Author: Andrew Aitken-Fincham <andrew@symbiote.com.au>
Synopsis
class CleanupJob
extends AbstractQueuedJob
{
- // members
- private static string $cleanup_method = "age";
- private static integer $cleanup_value = 30;
- private static array $cleanup_statuses = ;
- private static integer $query_limit = 100000;
- private static boolean $is_enabled = false;
- // Inherited members from AbstractQueuedJob
- protected stdClass $jobData;
- protected array $messages;
- protected integer $totalSteps;
- protected integer $currentStep;
- protected boolean $isComplete;
- // methods
- public string getTitle()
- public int getJobType()
- public void process()
- private void reenqueue()
- // Inherited methods from AbstractQueuedJob
- public void __construct()
- public abstract string getTitle()
- protected void setObject()
- protected DataObject|null getObject()
- public string getSignature()
- protected string randomSignature()
- public string getJobType()
- public void getRunAsMemberID()
- public void setup()
- public void prepareForRestart()
- public abstract void process()
- public void jobFinished()
- public void afterComplete()
- public stdClass getJobData()
- public void setJobData()
- public array|null getCustomConfig()
- public void setCustomConfig()
- public void addMessage()
- public void __set()
- public mixed __get()
Hierarchy
Constants
Name | Value |
---|---|
IMMEDIATE | '1' |
QUEUED | '2' |
LARGE | '3' |
STATUS_NEW | 'New' |
STATUS_INIT | 'Initialising' |
STATUS_RUN | 'Running' |
STATUS_WAIT | 'Waiting' |
STATUS_COMPLETE | 'Complete' |
STATUS_PAUSED | 'Paused' |
STATUS_CANCELLED | 'Cancelled' |
STATUS_BROKEN | 'Broken' |
Members
private
- $cleanup_method
—
string
How we will determine "stale" Possible values: age, number - $cleanup_statuses
—
array
Which JobStatus values are OK to be deleted - $cleanup_value
—
integer
Value associated with cleanupMethod age => days, number => integer - $is_enabled
—
boolean
Check whether is enabled or not for BC - $query_limit
—
integer
Database query limit
protected
- $currentStep — int
- $isComplete — boolean
- $jobData — stdClass
- $messages — array
- $totalSteps — int
Methods
private
public
- getJobType() — Set immediacy of job
- getTitle() — Defines the title of the job
- process() — Clear out stale jobs based on the cleanup values
Inherited from Symbiote\QueuedJobs\Services\AbstractQueuedJob
protected
- getObject()
- randomSignature() — Generate a somewhat random signature
- setObject() — Sets a data object for persisting by adding its id and type to the serialised vars
public
- __get() — Retrieve some job data
- __set() — Convenience methods for setting and getting job data
- addMessage()
- afterComplete() — Called when the job is determined to be 'complete'
- getCustomConfig() — Gets custom config settings to use when running the job.
- getJobData()
- getJobType() — By default jobs should just go into the default processing queue
- getRunAsMemberID()
- getSignature() — Return a signature for this queued job
- getTitle()
- jobFinished() — Method for determining whether the job is finished - you may override it if there's more to it than just this
- prepareForRestart() — Run when an already setup job is being restarted.
- process() — Do some processing yourself!
- setCustomConfig() — Sets custom config settings to use when the job is run.
- setJobData()
- setup() — Performs setup tasks the first time this job is run.