MediaWiki  master
HTMLCacheUpdateJob Class Reference

Job to purge the cache for all pages that link to or use another page or file. More...

Inheritance diagram for HTMLCacheUpdateJob:
Collaboration diagram for HTMLCacheUpdateJob:

Public Member Functions

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

Static Public Member Functions

static newForBacklinks (Title $title, $table, $params=[])
 
- Static Public Member Functions inherited from Job
static factory ( $command, $params=[])
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 Get "root job" parameters for a task. More...
 

Protected Member Functions

 invalidateTitles (array $pages)
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

Additional Inherited Members

- Public Attributes inherited from Job
string $command
 
array $metadata = []
 Additional queue metadata. More...
 
array $params
 Array of job parameters. More...
 
- 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 = false
 Expensive jobs may set this to true. More...
 
callable [] $teardownCallbacks = []
 
Title $title
 

Detailed Description

Job to purge the cache for all pages that link to or use another page or file.

This job comes in a few variants:

  • a) Recursive jobs to purge caches for backlink pages for a given title. These jobs have (recursive:true,table:
    set.
  • b) Jobs to purge caches for a set of titles (the job title is ignored). These jobs have (pages:(<page id>="">:(<namespace>,<title>),...) set.

Definition at line 38 of file HTMLCacheUpdateJob.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLCacheUpdateJob::__construct ( Title  $title,
array  $params 
)

Definition at line 39 of file HTMLCacheUpdateJob.php.

Member Function Documentation

◆ getDeduplicationInfo()

HTMLCacheUpdateJob::getDeduplicationInfo ( )

Subclasses may need to override this to make duplication detection work.

The resulting map conveys everything that makes the job unique. This is only checked if ignoreDuplicates() returns true, meaning that duplicate jobs are supposed to be ignored.

Returns
array Map of key/values

Implements IJobSpecification.

Definition at line 179 of file HTMLCacheUpdateJob.php.

◆ invalidateTitles()

HTMLCacheUpdateJob::invalidateTitles ( array  $pages)
protected
Parameters
array$pagesMap of (page ID => (namespace, DB key)) entries

Definition at line 112 of file HTMLCacheUpdateJob.php.

References $batch, Job\$title, $urls, $wgPageLanguageUseDB, $wgUpdateRowsPerQuery, $wgUseFileCache, as, HTMLFileCache\clearFileCache(), DB_MASTER, TitleArray\newFromResult(), CdnCacheUpdate\purge(), wfGetDB(), and wfTimestampNow().

Referenced by run().

◆ newForBacklinks()

static HTMLCacheUpdateJob::newForBacklinks ( Title  $title,
  $table,
  $params = [] 
)
static
Parameters
Title$titleTitle to purge backlink pages from
string$tableBacklink table name
array$paramsAdditional job parameters
Returns
HTMLCacheUpdateJob

Definition at line 59 of file HTMLCacheUpdateJob.php.

References Job\$params, Job\$title, Job\newRootJobParams(), and true.

Referenced by HTMLCacheUpdate\doUpdate().

◆ run()

HTMLCacheUpdateJob::run ( )

◆ workItemCount()

HTMLCacheUpdateJob::workItemCount ( )
Returns
int Number of actually "work items" handled in this job
See also
$wgJobBackoffThrottling
Since
1.23

Implements RunnableJob.

Definition at line 193 of file HTMLCacheUpdateJob.php.


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