MediaWiki  master
RefreshLinksJob Class Reference

Job to update link tables for rerendered wiki 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. More...
 
 run ()
 Run the job. More...
 
 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
More...
 
 getLastError ()
 
Returns
string
More...
 
 getMetadata ( $field=null)
 
 getParams ()
 
Returns
array Parameters that specify sources, targets, and options for execution
More...
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
Returns
int|null UNIX timestamp of when the job was runnable, or null
Since
1.26
More...
 
 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
More...
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
Returns
string Job type that defines what sort of changes this job makes
More...
 
 hasExecutionFlag ( $flag)
 
Parameters
int$flagJOB_* class constant
Returns
bool
Since
1.31
More...
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 Whether the queue should reject insertion of this job if a duplicate exists. More...
 
 isRootJob ()
 
 setMetadata ( $field, $value)
 
 teardown ( $status)
 
 toString ()
 
Returns
string Debugging string describing the job
More...
 
- Public Member Functions inherited from RunnableJob
 tearDown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 

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

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. More...
 
array $params
 Array of job parameters. More...
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last. More...
 
int $executionFlags = 0
 Bitfield of JOB_* class constants. More...
 
bool $removeDuplicates = false
 Expensive jobs may set this to true. More...
 
callable[] $teardownCallbacks = []
 
Title $title
 

Detailed Description

Job to update link tables for rerendered wiki 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 56 of file RefreshLinksJob.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 62 of file RefreshLinksJob.php.

References Job\$params, and 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 446 of file RefreshLinksJob.php.

◆ newDynamic()

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

Definition at line 103 of file RefreshLinksJob.php.

References $job, and Job\$params.

Referenced by WikiPage\triggerOpportunisticLinksUpdate().

◆ newPrioritized()

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

Definition at line 91 of file RefreshLinksJob.php.

References $job, and Job\$params.

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

◆ run()

RefreshLinksJob::run ( )

◆ runForTitle()

RefreshLinksJob::runForTitle ( PageIdentity  $pageIdentity)
protected
Parameters
PageIdentity$pageIdentity
Returns
bool

Definition at line 171 of file RefreshLinksJob.php.

References DB_PRIMARY, InfoAction\invalidateCache(), and Job\setLastError().

Referenced by run().

◆ workItemCount()

RefreshLinksJob::workItemCount ( )
Stability: stable
to override
Returns
int

Reimplemented from Job.

Definition at line 462 of file RefreshLinksJob.php.


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