RefreshLinksJob Class Reference

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

Inheritance diagram for RefreshLinksJob:

Collaboration diagram for RefreshLinksJob:

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 ()
Public Member Functions inherited from Job
	__construct ( $command, $title, $params=false)
	allowRetries ()
	getLastError ()
	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.
	isRootJob ()
	teardown ( $status)
	Do any final cleanup after run(), deferred updates, and all DB commits happen.
	toString ()

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

Protected Member Functions
	runForTitle (Title $title)
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
	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.

Definition at line 39 of file RefreshLinksJob.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 47 of file RefreshLinksJob.php.

References Job\$params.

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.

Returns

array Map of key/values

Since

1.21

Reimplemented from Job.

Definition at line 292 of file RefreshLinksJob.php.

newDynamic()

static RefreshLinksJob::newDynamic ( Title $title, array $params )

static

Parameters

Title	$title
array	$params

Returns

RefreshLinksJob

Definition at line 76 of file RefreshLinksJob.php.

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

Referenced by WikiPage\triggerOpportunisticLinksUpdate().

newPrioritized()

static RefreshLinksJob::newPrioritized ( Title $title, array $params )

static

Parameters

Title	$title
array	$params

Returns

RefreshLinksJob

Definition at line 64 of file RefreshLinksJob.php.

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

Referenced by LinksUpdate\queueRecursiveJobs(), and WikiPage\triggerOpportunisticLinksUpdate().

run()

RefreshLinksJob::run

(

)

Run the job.

Returns

bool Success

Reimplemented from Job.

Definition at line 83 of file RefreshLinksJob.php.

References $wgUpdateRowsPerJob, Job\getRootJobParams(), list, BacklinkJobUtils\partitionBacklinkJob(), and runForTitle().

runForTitle()

RefreshLinksJob::runForTitle ( Title $title )

protected

Parameters

Title

$title

Returns

bool

Definition at line 134 of file RefreshLinksJob.php.

References $options, $services, DB_MASTER, InfoAction\invalidateCache(), User\newFromId(), User\newFromName(), Job\setLastError(), and wfTimestamp().

Referenced by run().

workItemCount()

RefreshLinksJob::workItemCount

(

)

Returns

int Number of actually "work items" handled in this job

See also

$wgJobBackoffThrottling

Since

1.23

Reimplemented from Job.

Definition at line 308 of file RefreshLinksJob.php.

---

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

• includes/jobqueue/jobs/RefreshLinksJob.php