MediaWiki  master
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. More...
 
 run ()
 Run the job. More...
 
 workItemCount ()
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 getMetadata ( $field=null)
 
 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. More...
 
 isRootJob ()
 
 setMetadata ( $field, $value)
 
 teardown ( $status)
 
 toString ()
 
 workItemCount ()
 
- 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 (Title $title, array $params)
 
static newPrioritized (Title $title, 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 (Title $title)
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

Private Member Functions

 getCurrentRevisionIfUnchanged (WikiPage $page, StatsdDataFactoryInterface $stats)
 Get the current revision record if it is unchanged from what was loaded in $page. More...
 
 getDataUpdateOptions ()
 
 getParserOutput (RevisionRenderer $renderer, ParserCache $parserCache, WikiPage $page, StatsdDataFactoryInterface $stats)
 Get the parser output if the page is unchanged from what was loaded in $page. More...
 
 getParserOutputFromCache (ParserCache $parserCache, WikiPage $page, RevisionRecord $currentRevision, StatsdDataFactoryInterface $stats)
 Get the parser output from cache if it reflects the change that triggered this job. More...
 
 isAlreadyRefreshed (WikiPage $page)
 

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

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 47 of file RefreshLinksJob.php.

Member Function Documentation

◆ getCurrentRevisionIfUnchanged()

RefreshLinksJob::getCurrentRevisionIfUnchanged ( WikiPage  $page,
StatsdDataFactoryInterface  $stats 
)
private

Get the current revision record if it is unchanged from what was loaded in $page.

Parameters
WikiPage$pagePage already loaded with READ_LATEST
StatsdDataFactoryInterface$stats
Returns
RevisionRecord|null The same instance that $page->getRevisionRecord() uses

Definition at line 272 of file RefreshLinksJob.php.

References Job\$title, Title\GAID_FOR_UPDATE, WikiPage\getId(), Title\getLatestRevID(), WikiPage\getRevisionRecord(), WikiPage\getTitle(), null, and Job\setLastError().

Referenced by getParserOutput().

◆ getDataUpdateOptions()

RefreshLinksJob::getDataUpdateOptions ( )
private
Returns
array

Definition at line 375 of file RefreshLinksJob.php.

References $options, User\newFromId(), and User\newFromName().

Referenced by runForTitle().

◆ 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

Implements IJobSpecification.

Definition at line 395 of file RefreshLinksJob.php.

◆ getParserOutput()

RefreshLinksJob::getParserOutput ( RevisionRenderer  $renderer,
ParserCache  $parserCache,
WikiPage  $page,
StatsdDataFactoryInterface  $stats 
)
private

Get the parser output if the page is unchanged from what was loaded in $page.

Parameters
RevisionRenderer$renderer
ParserCache$parserCache
WikiPage$pagePage already loaded with READ_LATEST
StatsdDataFactoryInterface$stats
Returns
ParserOutput|null Combined output for all slots; might only contain metadata

Definition at line 235 of file RefreshLinksJob.php.

References $output, getCurrentRevisionIfUnchanged(), getParserOutputFromCache(), Revision\RevisionRenderer\getRenderedRevision(), WikiPage\makeParserOptions(), null, and wfTimestampNow().

Referenced by runForTitle().

◆ getParserOutputFromCache()

RefreshLinksJob::getParserOutputFromCache ( ParserCache  $parserCache,
WikiPage  $page,
RevisionRecord  $currentRevision,
StatsdDataFactoryInterface  $stats 
)
private

Get the parser output from cache if it reflects the change that triggered this job.

Parameters
ParserCache$parserCache
WikiPage$page
RevisionRecord$currentRevision
StatsdDataFactoryInterface$stats
Returns
ParserOutput|null

Definition at line 322 of file RefreshLinksJob.php.

References $output, ParserCache\getDirty(), Revision\RevisionRecord\getId(), WikiPage\getTouched(), WikiPage\makeParserOptions(), null, and wfTimestamp().

Referenced by getParserOutput().

◆ isAlreadyRefreshed()

RefreshLinksJob::isAlreadyRefreshed ( WikiPage  $page)
private
Parameters
WikiPage$page
Returns
bool Whether something updated the backlinks with data newer than this job

Definition at line 204 of file RefreshLinksJob.php.

References WikiPage\getLinksTimestamp(), null, and wfTimestamp().

Referenced by runForTitle().

◆ newDynamic()

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

Definition at line 80 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 68 of file RefreshLinksJob.php.

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

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

◆ run()

RefreshLinksJob::run ( )

◆ runForTitle()

RefreshLinksJob::runForTitle ( Title  $title)
protected

◆ workItemCount()

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

Implements RunnableJob.

Definition at line 411 of file RefreshLinksJob.php.


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