MediaWiki master
|
Job to purge a set of URLs from CDN. More...
Inherits Job, and GenericParameterJob.
Public Member Functions | ||||
__construct (array $params) | ||||
run () | ||||
Run the job. | ||||
![]() | ||||
__construct ( $command, $params=null) | ||||
allowRetries () | ||||
Whether to retry execution of this job if run() returned false or threw an exception.
| ||||
getDeduplicationInfo () | ||||
Subclasses may need to override this to make duplication detection work. | ||||
getLastError () | ||||
| ||||
getMetadata ( $field=null) | ||||
getParams () | ||||
| ||||
getQueuedTimestamp () | ||||
getReadyTimestamp () | ||||
| ||||
getReleaseTimestamp () | ||||
getRequestId () | ||||
| ||||
getRootJobParams () | ||||
getTitle () | ||||
getType () | ||||
| ||||
hasExecutionFlag ( $flag) | ||||
| ||||
hasRootJobParams () | ||||
ignoreDuplicates () | ||||
Whether the queue should reject insertion of this job if a duplicate exists. | ||||
isRootJob () | ||||
setMetadata ( $field, $value) | ||||
teardown ( $status) | ||||
toString () | ||||
| ||||
workItemCount () | ||||
![]() | ||||
tearDown ( $status) | ||||
Do any final cleanup after run(), deferred updates, and all DB commits happen. | ||||
Additional Inherited Members | |
![]() | |
static | factory ( $command, $params=[]) |
Create the appropriate object to handle a specific job. | |
static | newRootJobParams ( $key) |
Get "root job" parameters for a task. | |
![]() | |
string | $command |
array | $metadata = [] |
Additional queue metadata. | |
array | $params |
Array of job parameters. | |
![]() | |
addTeardownCallback ( $callback) | |
setLastError ( $error) | |
![]() | |
string | $error |
Text for error that occurred last. | |
int | $executionFlags = 0 |
Bitfield of JOB_* class constants. | |
bool | $removeDuplicates = false |
Expensive jobs may set this to true. | |
callable[] | $teardownCallbacks = [] |
Title | $title |
CdnPurgeJob::__construct | ( | array | $params | ) |
array | $params | JSON-serializable map of parameters |
Implements GenericParameterJob.
Definition at line 30 of file CdnPurgeJob.php.
References $params.
CdnPurgeJob::run | ( | ) |
Run the job.
If this method returns false
or completes exceptionally, the job runner will retry executing this job unless the number of retries has exceeded its configured retry limit. Retries are allowed by default, unless allowRetries() is overridden to disable retries.
See the architecture doc for more information.
false
to instruct the job runner to retry a failed job. Otherwise return true
to indicate that a job completed (i.e. succeeded, or failed in a way that's deterministic or redundant). Implements RunnableJob.
Definition at line 35 of file CdnPurgeJob.php.