MediaWiki  1.23.12
RefreshLinksJob Class Reference

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

Inheritance diagram for RefreshLinksJob:
Collaboration diagram for RefreshLinksJob:

Public Member Functions

 __construct ( $title, $params='')
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 run ()
 Run the job. More...
 
 workItemCount ()
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 allowRetries ()
 
 getLastError ()
 
 getParams ()
 
 getReleaseTimestamp ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 
 insert ()
 Insert a single job into the queue. More...
 
 toString ()
 

Public Attributes

const PARSE_THRESHOLD_SEC = 1.0
 
- 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 Member Functions

 runForTitle (Title $title=null)
 
- 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...
 
- 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 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 have (recursive:true,table:
    set.
  • b) Jobs to update links for a set of pages (the job title is ignored). These jobs have 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 37 of file RefreshLinksJob.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 40 of file RefreshLinksJob.php.

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

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 180 of file RefreshLinksJob.php.

◆ run()

RefreshLinksJob::run ( )

Run the job.

Returns
bool Success

Reimplemented from Job.

Definition at line 61 of file RefreshLinksJob.php.

References array(), as, Job\getRootJobParams(), global, list, Title\makeTitleSafe(), BacklinkJobUtils\partitionBacklinkJob(), runForTitle(), JobQueueGroup\singleton(), title, and wfGetLB().

◆ runForTitle()

◆ workItemCount()

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

Reimplemented from Job.

Definition at line 196 of file RefreshLinksJob.php.

Member Data Documentation

◆ PARSE_THRESHOLD_SEC

const RefreshLinksJob::PARSE_THRESHOLD_SEC = 1.0

Definition at line 38 of file RefreshLinksJob.php.


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