LDAPMemberSyncJob
class LDAPMemberSyncJob extends AbstractQueuedJob (View source)
Class LDAPMemberSyncJob
A {@link QueuedJob} job to sync all users to the site using LDAP. This doesn't do the actual sync work, but rather just triggers {@link LDAPMemberSyncTask}
Properties
| static private mixed | $regenerate_time | If you specify this value in seconds, it tells the completed job to queue another of itself x seconds ahead of time. |
Methods
Extensions can have a construct but don't have too.
No description
No description
No description
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
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()
Extensions can have a construct but don't have too.
Without a construct, it's impossible to create a job in the CMS
string
getTitle()
string
getSignature()
getJobType()
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