MediaWiki  1.23.6
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, $params='')
 
 run ()
 Run the job. More...
 
 workItemCount ()
 
- 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 ()
 
 getReleaseTimestamp ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 
 insert ()
 Insert a single job into the queue. More...
 
 toString ()
 

Protected Member Functions

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

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=false)
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 
static pop ()
 Pop a job off the front of the queue. More...
 
static pop_type ( $type)
 Pop a job of a certain type. More...
 
static safeBatchInsert ( $jobs)
 Insert a group of jobs into the queue. More...
 
- Public Attributes inherited from Job
string $command
 
array $metadata = array()
 Additional queue metadata *. More...
 
array bool $params
 Array of job parameters or false if none *. More...
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last *. More...
 
bool $removeDuplicates
 Expensive jobs may set this to true *. More...
 
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 have (recursive:true,table:
    set.
  • b) Jobs to purge caches for a set of titles (the job title is ignored). These jobs have have (pages:(<page ID>:(<namespace>,<title>),...) set.

Definition at line 35 of file HTMLCacheUpdateJob.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLCacheUpdateJob::__construct (   $title,
  $params = '' 
)

Definition at line 36 of file HTMLCacheUpdateJob.php.

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

Member Function Documentation

◆ invalidateTitles()

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

Definition at line 101 of file HTMLCacheUpdateJob.php.

References $batch, Job\$title, array(), as, HTMLFileCache\clearFileCache(), DB_MASTER, global, TitleArray\newFromResult(), SquidUpdate\newFromTitles(), wfGetDB(), and wfTimestampNow().

Referenced by run().

◆ run()

HTMLCacheUpdateJob::run ( )

Run the job.

Returns
bool Success

Reimplemented from Job.

Definition at line 42 of file HTMLCacheUpdateJob.php.

References array(), as, Job\getRootJobParams(), global, invalidateTitles(), BacklinkJobUtils\partitionBacklinkJob(), JobQueueGroup\singleton(), and title.

◆ workItemCount()

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

Reimplemented from Job.

Definition at line 159 of file HTMLCacheUpdateJob.php.


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