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

Collaboration diagram for MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob:

[legend]

Public Member Functions

__construct (Title $title, array $params)

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.

Stability: stable: to override

Returns: array Map of key/values

Since: 1.21

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.

Returns: bool Return 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).

workItemCount ()

Stability: stable: to override

Returns: int

Public Member Functions inherited from MediaWiki\JobQueue\Job

__construct ( $command, $params=null)

allowRetries ()

Whether to retry execution of this job if run() returned false or threw an exception.

Warning: In some setups (i.e. when using change-propagation) jobs may still be retried even when this is false if the job fails due to a timeout unless it is also configured in change-prop config (T358939).

Returns: bool Whether this job can be retried on failure by job runners

Since: 1.21

getLastError ()

Returns: string

getMetadata ( $field=null)

getParams ()

Returns: array Parameters that specify sources, targets, and options for execution

getQueuedTimestamp ()

getReadyTimestamp ()

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

getReleaseTimestamp ()

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

getRootJobParams ()

getTitle ()

getType ()

Returns: string Job type that defines what sort of changes this job makes

hasExecutionFlag ( $flag)

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

hasRootJobParams ()

ignoreDuplicates ()

Whether the queue should reject insertion of this job if a duplicate exists.

isRootJob ()

setMetadata ( $field, $value)

teardown ( $status)

toString ()

Returns: string Debugging string describing the job

Public Member Functions inherited from MediaWiki\JobQueue\RunnableJob

tearDown ( $status)

Do any final cleanup after run(), deferred updates, and all DB commits happen.

Static Public Member Functions
static	newForBacklinks (PageReference $page, $table, $params=[])

Static Public Member Functions inherited from MediaWiki\JobQueue\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 MediaWiki\JobQueue\Job
	addTeardownCallback ( $callback)

	setLastError ( $error)

Additional Inherited Members
Public Attributes inherited from MediaWiki\JobQueue\Job
string	$command

array	$metadata = []
	Additional queue metadata.

array	$params
	Array of job parameters.

Protected Attributes inherited from MediaWiki\JobQueue\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 29 of file HTMLCacheUpdateJob.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob::__construct	(	Title	$title,
		array	$params )

Definition at line 33 of file HTMLCacheUpdateJob.php.

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

Member Function Documentation

◆ getDeduplicationInfo()

MediaWiki\JobQueue\Jobs\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.

Stability: stable: to override

Returns: array Map of key/values

Since: 1.21

Reimplemented from MediaWiki\JobQueue\Job.

Definition at line 173 of file HTMLCacheUpdateJob.php.

◆ invalidateTitles()

MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob::invalidateTitles ( array $pages )

protected

Parameters

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

Definition at line 111 of file HTMLCacheUpdateJob.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\PageLanguageUseDB, MediaWiki\MainConfigNames\UpdateRowsPerQuery, wfTimestamp(), and wfTimestampOrNull().

Referenced by MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob\run().

◆ newForBacklinks()

static MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob::newForBacklinks	(	PageReference	$page,
			$table,
			$params = [] )

static

Parameters

PageReference	$page	Page to purge backlink pages from
string	$table	Backlink table name
array	$params	Additional job parameters

Returns: HTMLCacheUpdateJob

Definition at line 54 of file HTMLCacheUpdateJob.php.

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

◆ run()

MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob::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.

Returns: bool Return 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 MediaWiki\JobQueue\RunnableJob.

Definition at line 68 of file HTMLCacheUpdateJob.php.

References MediaWiki\JobQueue\Job\$title, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\JobQueue\Job\getRootJobParams(), MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob\invalidateTitles(), MediaWiki\MainConfigNames\UpdateRowsPerJob, and MediaWiki\MainConfigNames\UpdateRowsPerQuery.

◆ workItemCount()

MediaWiki\JobQueue\Jobs\HTMLCacheUpdateJob::workItemCount ( )

Stability: stable: to override

Returns: int

Reimplemented from MediaWiki\JobQueue\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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDeduplicationInfo()

◆ invalidateTitles()

◆ newForBacklinks()

◆ run()

◆ workItemCount()