RefreshLinksJob Class Reference

Job to update link tables for pages. More...

Inheritance diagram for RefreshLinksJob:

Collaboration diagram for RefreshLinksJob:

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

Static Public Member Functions
static	newDynamic (PageIdentity $page, array $params)
static	newPrioritized (PageIdentity $page, array $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
	runForTitle (PageIdentity $pageIdentity)
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 update link tables for pages.

This job comes in a few variants:

• a) Recursive jobs to update links for backlink pages for a given title. These jobs have (recursive:true,table: set.
• b) Jobs to update links for a set of pages (the job title is ignored). These jobs have (pages:(<page ID>:(<namespace>,<title>),...) set.
• c) Jobs to update links for a single page (the job title) These jobs need no extra fields set.

Metrics:

• refreshlinks_warning.<warning>: A recoverable issue. The job will continue as normal.
• refreshlinks_outcome.<reason>: If the job ends with an unusual outcome, it will increment this exactly once. The reason starts with bad_, a failure is logged and the job may be retried later. The reason starts with good_, the job was cancelled and considered a success, i.e. it was superseded.

Definition at line 58 of file RefreshLinksJob.php.

Constructor & Destructor Documentation

__construct()

RefreshLinksJob::__construct	(	PageIdentity	$page,
		array	$params )

Definition at line 64 of file RefreshLinksJob.php.

References MediaWiki\Page\PageIdentity\canExist().

Member Function Documentation

getDeduplicationInfo()

RefreshLinksJob::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 Job.

Definition at line 448 of file RefreshLinksJob.php.

newDynamic()

static RefreshLinksJob::newDynamic ( PageIdentity $page, array $params )

static

Parameters

PageIdentity	$page
array	$params

Returns

RefreshLinksJob

Definition at line 105 of file RefreshLinksJob.php.

References $job.

newPrioritized()

static RefreshLinksJob::newPrioritized ( PageIdentity $page, array $params )

static

Parameters

PageIdentity	$page
array	$params

Returns

RefreshLinksJob

Definition at line 93 of file RefreshLinksJob.php.

References $job.

Referenced by MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobs().

run()

RefreshLinksJob::run

(

)

Run the job.

Returns

bool Success

Implements RunnableJob.

Definition at line 112 of file RefreshLinksJob.php.

References $title, Job\getRootJobParams(), BacklinkJobUtils\partitionBacklinkJob(), runForTitle(), and Job\setLastError().

runForTitle()

RefreshLinksJob::runForTitle ( PageIdentity $pageIdentity )

protected

Parameters

PageIdentity

$pageIdentity

Returns

bool

Definition at line 173 of file RefreshLinksJob.php.

References DB_PRIMARY, and Job\setLastError().

Referenced by run().

workItemCount()

RefreshLinksJob::workItemCount

(

)

Stability: stable

to override

Returns

int

Reimplemented from Job.

Definition at line 464 of file RefreshLinksJob.php.

---

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

• includes/jobqueue/jobs/RefreshLinksJob.php