GenerateGoogleSitemapJob
class GenerateGoogleSitemapJob extends AbstractQueuedJob (View source)
A job for generating a site's google sitemap
If the sitemap module is installed, uses information from that to populate things
Traits
Provides extensions to this object to integrate it with standard config API methods.
Config options
| regenerate_time | int |
Properties
| protected | stdClass | $jobData | from AbstractQueuedJob | |
| protected | array | $messages | from AbstractQueuedJob | |
| protected | int | $totalSteps | from AbstractQueuedJob | |
| protected | int | $currentStep | from AbstractQueuedJob | |
| protected | bool | $isComplete | from AbstractQueuedJob |
Methods
Sets a data object for persisting by adding its id and type to the serialised vars
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
On any restart, make sure to check that our temporary file is being created still.
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
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
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()
No description
protected
setObject(DataObject $object, string $name = 'Object')
Sets a data object for persisting by adding its id and type to the serialised vars
protected DataObject|null
getObject(string $name = 'Object')
No description
string
getSignature()
Return a signature for this queued job
For the generate sitemap job, we only ever want one instance running, so just use the class name
protected string
randomSignature()
Generate a somewhat random signature
useful if you're want to make sure something is always added
getJobType()
Sitemap job is going to run for a while.
..
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 QueuedJobService::queueJob()
setup()
Note that this is duplicated for backwards compatibility purposes.
..
prepareForRestart()
On any restart, make sure to check that our temporary file is being created still.
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()
No description
setJobData(int $totalSteps, int $currentStep, bool $isComplete, stdClass $jobData, array $messages)
No description
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')
No description
__set(mixed $name, mixed $value)
Convenience methods for setting and getting job data
mixed
__get(mixed $name)
Retrieve some job data
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
protected
completeJob()
Outputs the completed file to the site's webroot