JobManager
in package
FinalYes
A singleton class defining a manager for asyncrhonous jobs.
In reality, this is a simple proxy for methods in the CmsJobManager module.
Tags
Table of Contents
Methods
- delete_job() : mixed
- Remove a job from the queue
- delete_jobs_by_module() : mixed
- Remove all of the jbos originating from a specific module
- get_instance() : JobManager
- Get the sole permitted instance of this object
- load_job() : Job
- Given an integer job id, load the job.
- save_job() : int
- Save a job to the queue.
Methods
delete_job()
Remove a job from the queue
public
delete_job(Job &$job) : mixed
Note: After calling this method, the job object itself is invalid and cannot be saved.
Parameters
- $job : Job
delete_jobs_by_module()
Remove all of the jbos originating from a specific module
public
delete_jobs_by_module(string $module_name) : mixed
Parameters
- $module_name : string
get_instance()
Get the sole permitted instance of this object
public
static get_instance() : JobManager
Return values
JobManagerload_job()
Given an integer job id, load the job.
public
load_job(int $job_id) : Job
Parameters
- $job_id : int
Return values
Jobsave_job()
Save a job to the queue.
public
save_job(Job &$job) : int
Parameters
- $job : Job
Return values
int —The id of the job.