ScheduledExecutionJob
class ScheduledExecutionJob extends AbstractQueuedJob (View source)
A job that gets executed on a particular schedule. When it runs, it will call the onScheduledExecution method on the owning dataobject.
Methods
No description
By default jobs should just go into the default processing queue
Specifies what user ID should be when running the job valid values: null - (default) - run the job as current user 0 - run the job without a user greater than zero - run the job as a specific user
Performs setup tasks the first time this job is run.
Do some processing yourself!
Method for determining whether the job is finished - you may override it if there's more to it than just this
No description
Gets custom config settings to use when running the job.
Sets custom config settings to use when the job is run.
Convenience methods for setting and getting job data
No description
Details
__construct(DataObject $dataObject = null, int $timesExecuted = 0)
string
getTitle()
string
getSignature()
Return a signature for this queued job
getJobType()
By default jobs should just go into the default processing queue
int|null
getRunAsMemberID()
Specifies what user ID should be when running the job valid values: null - (default) - run the job as current user 0 - run the job without a user greater than zero - run the job as a specific user
This is useful in situations like:
- a job needs to always run without a user (like a static cache job)
- a job needs to run as a specific user (for example data migration job)
Note that this value can be overridden in the see QueuedJobService::queueJob()
setup()
Performs setup tasks the first time this job is run.
This is only executed once for every job. If you want to run something on every job restart, use the {@link prepareForRestart} method.
prepareForRestart()
Run when an already setup job is being restarted.
process()
Do some processing yourself!
jobFinished()
Method for determining whether the job is finished - you may override it if there's more to it than just this
afterComplete()
Called when the job is determined to be 'complete'
getJobData()
setJobData(int $totalSteps, int $currentStep, bool $isComplete, stdClass $jobData, array $messages)
array|null
getCustomConfig()
Gets custom config settings to use when running the job.
setCustomConfig(array $config)
Sets custom config settings to use when the job is run.
addMessage(string $message, string $severity = 'INFO')
__set(mixed $name, mixed $value)
Convenience methods for setting and getting job data
mixed
__get(mixed $name)
Retrieve some job data