MediaWiki  REL1_31
CdnPurgeJob Class Reference

Job to purge a set of URLs from CDN. More...

Inheritance diagram for CdnPurgeJob:
Collaboration diagram for CdnPurgeJob:

Public Member Functions

 __construct (Title $title, array $params)
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 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. More...
 
 insert ()
 Insert a single job into the queue. More...
 
 isRootJob ()
 
 teardown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 
 toString ()
 
 workItemCount ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Job
static batchInsert ( $jobs)
 Batch-insert a group of jobs into the queue. More...
 
static factory ( $command, Title $title, $params=[])
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 Get "root job" parameters for a task. More...
 
- Public Attributes inherited from Job
string $command
 
array $metadata = []
 Additional queue metadata. More...
 
array $params
 Array of job parameters. More...
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last. More...
 
int $executionFlags = 0
 Bitfield of JOB_* class constants. More...
 
bool $removeDuplicates
 Expensive jobs may set this to true. More...
 
callable[] $teardownCallbacks = []
 
Title $title
 

Detailed Description

Job to purge a set of URLs from CDN.

Since
1.27

Definition at line 30 of file CdnPurgeJob.php.

Constructor & Destructor Documentation

◆ __construct()

CdnPurgeJob::__construct ( Title  $title,
array  $params 
)
Parameters
Title$title
array$paramsJob parameters (urls)

Definition at line 35 of file CdnPurgeJob.php.

References Job\$params, and Job\$title.

Member Function Documentation

◆ run()

CdnPurgeJob::run ( )

Run the job.

Returns
bool Success

Reimplemented from Job.

Definition at line 40 of file CdnPurgeJob.php.

References CdnCacheUpdate\purge().


The documentation for this class was generated from the following file: