HTMLCacheUpdateJob Class Reference

Job to purge the HTML/file 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.
	run ()
	Run the job.
	workItemCount ()
	Stable to override.
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	Stable to call.
	allowRetries ()
	Returns bool Whether this job can be retried on failure by job runners Since 1.21 Stable to override
	getLastError ()
	Returns string Stable to override
	getMetadata ( $field=null)
	Stable to override.
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution Stable to override
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26 Stable to override
	getReleaseTimestamp ()
	Stable to override.
	getRequestId ()
	Returns string|null Id of the request that created this job. Follows jobs recursively, allowing to track the id of the request that started a job when jobs insert jobs which insert other jobs. Since 1.27 Stable to override
	getRootJobParams ()
	Stable to override.
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes Stable to override
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31 Stable to override
	hasRootJobParams ()
	Stable to override.
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	Stable to override.
	setMetadata ( $field, $value)
	Stable to override.
	teardown ( $status)
	Stable to override
	toString ()
	Returns string Debugging string describing the job Stable to override
Public Member Functions inherited from RunnableJob
	tearDown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.

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.
static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

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.
array	$params
	Array of job parameters.
Protected Attributes inherited from Job
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

Detailed Description

Job to purge the HTML/file 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 35 of file HTMLCacheUpdateJob.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 39 of file HTMLCacheUpdateJob.php.

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

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.

Stable to override

Returns

array Map of key/values

Since

1.21

Reimplemented from Job.

Definition at line 174 of file HTMLCacheUpdateJob.php.

invalidateTitles()

HTMLCacheUpdateJob::invalidateTitles ( array  $pages )

protected

Parameters

array

$pages

Map of (page ID => (namespace, DB key)) entries

Definition at line 112 of file HTMLCacheUpdateJob.php.

References DB_MASTER, and wfTimestampOrNull().

Referenced by run().

newForBacklinks()

static HTMLCacheUpdateJob::newForBacklinks ( Title  $title,   $table,   $params = []  )

static

Parameters

Title	$title	Title to purge backlink pages from
string	$table	Backlink table name
array	$params	Additional job parameters

Returns

HTMLCacheUpdateJob

Definition at line 59 of file HTMLCacheUpdateJob.php.

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

Referenced by WikiFilePage\doPurge(), HTMLCacheUpdate\doUpdate(), LinksUpdate\invalidateProperties(), WikiPage\onArticleCreate(), WikiPage\onArticleDelete(), WikiPage\onArticleEdit(), File\purgeEverything(), Title\touchLinks(), and PageArchive\undeleteRevisions().

run()

HTMLCacheUpdateJob::run

(

)

Run the job.

Returns

bool Success

Implements RunnableJob.

Definition at line 71 of file HTMLCacheUpdateJob.php.

References $t, Job\$title, $wgUpdateRowsPerJob, $wgUpdateRowsPerQuery, Job\getRootJobParams(), invalidateTitles(), and BacklinkJobUtils\partitionBacklinkJob().

workItemCount()

HTMLCacheUpdateJob::workItemCount

(

)

Stable to override.

Returns

int

Reimplemented from Job.

Definition at line 188 of file HTMLCacheUpdateJob.php.

---

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

• includes/jobqueue/jobs/HTMLCacheUpdateJob.php