Class the manages updates of *_link tables as well as similar extension-managed tables. More...

Inheritance diagram for MediaWiki\Deferred\LinksUpdate\LinksUpdate:

[legend]

Collaboration diagram for MediaWiki\Deferred\LinksUpdate\LinksUpdate:

[legend]

Public Member Functions
	__construct (PageIdentity $page, ParserOutput $parserOutput, $recursive=true)

	doUpdate ()
	Update link tables with outgoing links from an updated article.

	getAddedExternalLinks ()
	Fetch external links added by this LinksUpdate.

	getAddedLinks ()
	Fetch page links added by this LinksUpdate.

	getAddedProperties ()
	Fetch page properties added by this LinksUpdate.

	getImages ()
	Return the list of images used as generated by the parser.

	getPageId ()
	Get the page_id of the page being updated.

	getPageReferenceArray ( $tableName, $setType)
	Same as getPageReferenceIterator() but converted to an array for convenience (at the expense of additional time and memory usage)

	getPageReferenceIterator ( $tableName, $setType)
	Get an iterator over PageReferenceValue objects corresponding to a given set type in a given table.

	getParserOutput ()
	Returns parser output.

	getRemovedExternalLinks ()
	Fetch external links removed by this LinksUpdate.

	getRemovedLinks ()
	Fetch page links removed by this LinksUpdate.

	getRemovedProperties ()
	Fetch page properties removed by this LinksUpdate.

	getRevisionRecord ()

	getTitle ()
	Return the title object of the page being updated.

	getTriggeringUser ()
	Get the user who triggered this LinksUpdate.

	isRecursive ()
	Whether or not this LinksUpdate will also update pages which transclude the current page or otherwise depend on it.

	setMoveDetails (PageReference $oldPage)
	Notify LinksUpdate that a move has just been completed and set the original title.

	setRevisionRecord (RevisionRecord $revisionRecord)
	Set the RevisionRecord corresponding to this LinksUpdate.

	setStrictTestMode ( $mode=true)
	Omit conflict resolution options from the insert query so that testing can confirm that the incremental update logic was correct.

	setTransactionTicket ( $ticket)

	setTriggeringUser (UserIdentity $user)
	Set the user who triggered this LinksUpdate.

Public Member Functions inherited from DataUpdate
	__construct ()

	getCauseAction ()

	getCauseAgent ()

	setCause ( $action, $user)

Static Public Member Functions
static	acquirePageLock (IDatabase $dbw, $pageId, $why='atomicity')
	Acquire a session-level lock for performing link table updates for a page on a DB.

static	queueRecursiveJobsForTable (PageIdentity $page, $table, $action='unknown', $userName='unknown', ?BacklinkCache $backlinkCache=null)
	Queue a RefreshLinks job for any table.

Static Public Member Functions inherited from DataUpdate
static	runUpdates (array $updates)
	Convenience method, calls doUpdate() on every DataUpdate in the array.

Protected Member Functions
	doIncrementalUpdate ()

	getDB ()

	getExternalLinksTable ()

	getPageLinksTable ()

	getPagePropsTable ()

	queueRecursiveJobs ()
	Queue recursive jobs for this page.

	updateLinksTimestamp ()
	Update links table freshness.

Protected Attributes
int	$mId
	Page ID of the article linked from.

ParserOutput	$mParserOutput

bool	$mRecursive
	Whether to queue jobs for recursive updates.

Title	$mTitle
	Title object of the article linked from.

Protected Attributes inherited from DataUpdate
string	$causeAction = 'unknown'
	Short update cause action description.

string	$causeAgent = 'unknown'
	Short update cause user description.

mixed	$ticket
	Result from LBFactory::getEmptyTransactionTicket()

Detailed Description

Class the manages updates of *_link tables as well as similar extension-managed tables.

Note: : LinksUpdate is managed by DeferredUpdates::execute(). Do not run this in a transaction.

See docs/deferred.txt

Definition at line 55 of file LinksUpdate.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::__construct	(	PageIdentity	$page,
		ParserOutput	$parserOutput,
			$recursive = true )

Parameters

PageIdentity	$page	The page we're updating
ParserOutput	$parserOutput	Output from a full parse of this page
bool	$recursive	Queue jobs for recursive updates?

Exceptions

MWException

Definition at line 94 of file LinksUpdate.php.

References $res, $title, deprecatePublicProperty(), deprecatePublicPropertyFallback(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Deferred\LinksUpdate\LinksUpdate\getParserOutput(), MediaWiki\Deferred\LinksUpdate\LinksTableGroup\setParserOutput(), MediaWiki\MainConfigNames\TempCategoryCollations, and MediaWiki\MainConfigNames\UpdateRowsPerQuery.

Member Function Documentation

◆ acquirePageLock()

static MediaWiki\Deferred\LinksUpdate\LinksUpdate::acquirePageLock	(	IDatabase	$dbw,
			$pageId,
			$why = 'atomicity' )

static

Acquire a session-level lock for performing link table updates for a page on a DB.

Parameters

IDatabase	$dbw
int	$pageId
string	$why	One of (job, atomicity)

Returns: ScopedCallback|null

Since: 1.27

Definition at line 277 of file LinksUpdate.php.

References Wikimedia\Rdbms\IDatabase\getScopedLockAndFlush().

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

◆ doIncrementalUpdate()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::doIncrementalUpdate ( )

protected

Reimplemented in MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate.

Definition at line 292 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobs(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\updateLinksTimestamp().

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

◆ doUpdate()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::doUpdate ( )

Update link tables with outgoing links from an updated article.

Note: this is managed by DeferredUpdates::execute(). Do not run this in a transaction.

Implements DeferrableUpdate.

Definition at line 214 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\acquirePageLock(), MediaWiki\Deferred\LinksUpdate\LinksUpdate\doIncrementalUpdate(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\getDB().

◆ getAddedExternalLinks()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getAddedExternalLinks ( )

Fetch external links added by this LinksUpdate.

Only available after the update is complete.

Since: 1.33

Returns: null|array Array of Strings

Definition at line 523 of file LinksUpdate.php.

◆ getAddedLinks()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getAddedLinks ( )

Fetch page links added by this LinksUpdate.

Only available after the update is complete.

Since: 1.22

Deprecated: since 1.38 use getPageReferenceIterator() or getPageReferenceArray()

Returns: Title[] Array of Titles

Definition at line 502 of file LinksUpdate.php.

◆ getAddedProperties()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getAddedProperties ( )

Fetch page properties added by this LinksUpdate.

Only available after the update is complete.

Since: 1.28

Returns: null|array

Definition at line 543 of file LinksUpdate.php.

◆ getDB()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getDB ( )

protected

Returns: IDatabase

Definition at line 613 of file LinksUpdate.php.

References DB_PRIMARY, and wfGetDB().

Referenced by MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate\doIncrementalUpdate(), MediaWiki\Deferred\LinksUpdate\LinksUpdate\doUpdate(), and MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate\getAsJobSpecification().

◆ getExternalLinksTable()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getExternalLinksTable ( )

protected

Returns: ExternalLinksTable

Definition at line 482 of file LinksUpdate.php.

◆ getImages()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getImages ( )

Return the list of images used as generated by the parser.

Returns: array

Definition at line 428 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\getParserOutput().

◆ getPageId()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getPageId ( )

Get the page_id of the page being updated.

Since: 1.38

Returns: int

Definition at line 407 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\$mId.

◆ getPageLinksTable()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getPageLinksTable ( )

protected

Returns: PageLinksTable

Definition at line 474 of file LinksUpdate.php.

◆ getPagePropsTable()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getPagePropsTable ( )

protected

Returns: PagePropsTable

Definition at line 490 of file LinksUpdate.php.

◆ getPageReferenceArray()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getPageReferenceArray	(		$tableName,
			$setType )

Same as getPageReferenceIterator() but converted to an array for convenience (at the expense of additional time and memory usage)

Since: 1.38

Parameters

string	$tableName
int	$setType

Returns: PageReferenceValue[]

Definition at line 591 of file LinksUpdate.php.

◆ getPageReferenceIterator()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getPageReferenceIterator	(		$tableName,
			$setType )

Get an iterator over PageReferenceValue objects corresponding to a given set type in a given table.

Since: 1.38

Parameters

string	$tableName	The name of any table that links to local titles
int	$setType	One of: LinksTable::INSERTED: The inserted links LinksTable::DELETED: The deleted links LinksTable::CHANGED: Both the inserted and deleted links LinksTable::OLD: The old set of links, loaded before the update LinksTable::NEW: The new set of links from the ParserOutput

Returns: iterable<PageReferenceValue>

Definition at line 572 of file LinksUpdate.php.

◆ getParserOutput()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getParserOutput ( )

Returns parser output.

Since: 1.19

Returns: ParserOutput

Definition at line 420 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\$mParserOutput.

Referenced by MediaWiki\Deferred\LinksUpdate\LinksUpdate\__construct(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\getImages().

◆ getRemovedExternalLinks()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getRemovedExternalLinks ( )

Fetch external links removed by this LinksUpdate.

Only available after the update is complete.

Since: 1.33

Returns: null|string[]

Definition at line 533 of file LinksUpdate.php.

◆ getRemovedLinks()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getRemovedLinks ( )

Fetch page links removed by this LinksUpdate.

Only available after the update is complete.

Since: 1.22

Deprecated: since 1.38 use getPageReferenceIterator() or getPageReferenceArray()

Returns: Title[] Array of Titles

Definition at line 513 of file LinksUpdate.php.

◆ getRemovedProperties()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getRemovedProperties ( )

Fetch page properties removed by this LinksUpdate.

Only available after the update is complete.

Since: 1.28

Returns: null|array

Definition at line 553 of file LinksUpdate.php.

◆ getRevisionRecord()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getRevisionRecord ( )

Since: 1.35

Returns: RevisionRecord|null

Definition at line 447 of file LinksUpdate.php.

◆ getTitle()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getTitle ( )

Return the title object of the page being updated.

Returns: Title

Definition at line 397 of file LinksUpdate.php.

References MediaWiki\Deferred\LinksUpdate\LinksUpdate\$mTitle.

◆ getTriggeringUser()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::getTriggeringUser ( )

Get the user who triggered this LinksUpdate.

Since: 1.27

Returns: UserIdentity|null

Definition at line 467 of file LinksUpdate.php.

◆ isRecursive()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::isRecursive ( )

Whether or not this LinksUpdate will also update pages which transclude the current page or otherwise depend on it.

Returns: bool

Definition at line 627 of file LinksUpdate.php.

◆ queueRecursiveJobs()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::queueRecursiveJobs ( )

protected

Queue recursive jobs for this page.

Which means do LinksUpdate on all pages that include the current page, using the job queue.

Definition at line 313 of file LinksUpdate.php.

References DataUpdate\getCauseAction(), DataUpdate\getCauseAgent(), MediaWiki\MediaWikiServices\getInstance(), RefreshLinksJob\newPrioritized(), NS_FILE, and MediaWiki\Deferred\LinksUpdate\LinksUpdate\queueRecursiveJobsForTable().

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

◆ queueRecursiveJobsForTable()

static MediaWiki\Deferred\LinksUpdate\LinksUpdate::queueRecursiveJobsForTable	(	PageIdentity	$page,
			$table,
			$action = 'unknown',
			$userName = 'unknown',
		?BacklinkCache	$backlinkCache = null )

static

Queue a RefreshLinks job for any table.

Parameters

PageIdentity	$page	Page to do job for
string	$table	Table to use (e.g. 'templatelinks')
string	$action	Triggering action
string	$userName	Triggering user name
BacklinkCache \| null	$backlinkCache

Definition at line 357 of file LinksUpdate.php.

References $job, $title, MediaWiki\MediaWikiServices\getInstance(), Job\newRootJobParams(), and wfDeprecatedMsg().

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

◆ setMoveDetails()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::setMoveDetails ( PageReference $oldPage )

Notify LinksUpdate that a move has just been completed and set the original title.

Parameters

PageReference $oldPage

Definition at line 205 of file LinksUpdate.php.

◆ setRevisionRecord()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::setRevisionRecord ( RevisionRecord $revisionRecord )

Set the RevisionRecord corresponding to this LinksUpdate.

Since: 1.35

Parameters

RevisionRecord $revisionRecord

Definition at line 438 of file LinksUpdate.php.

◆ setStrictTestMode()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::setStrictTestMode ( $mode = true )

Omit conflict resolution options from the insert query so that testing can confirm that the incremental update logic was correct.

Parameters

bool $mode

Definition at line 389 of file LinksUpdate.php.

◆ setTransactionTicket()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::setTransactionTicket ( $ticket )

Parameters

mixed $ticket Result of getEmptyTransactionTicket()

Since: 1.28

Reimplemented from DataUpdate.

Definition at line 194 of file LinksUpdate.php.

References DataUpdate\$ticket.

◆ setTriggeringUser()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::setTriggeringUser ( UserIdentity $user )

Set the user who triggered this LinksUpdate.

Since: 1.27

Parameters

UserIdentity $user

Definition at line 457 of file LinksUpdate.php.

◆ updateLinksTimestamp()

MediaWiki\Deferred\LinksUpdate\LinksUpdate::updateLinksTimestamp ( )

protected

Update links table freshness.

Definition at line 598 of file LinksUpdate.php.

References getDB().

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

Member Data Documentation

◆ $mId

int MediaWiki\Deferred\LinksUpdate\LinksUpdate::$mId

protected

Page ID of the article linked from.

Definition at line 62 of file LinksUpdate.php.

Referenced by MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate\doIncrementalUpdate(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\getPageId().

◆ $mParserOutput

ParserOutput MediaWiki\Deferred\LinksUpdate\LinksUpdate::$mParserOutput

protected

Definition at line 68 of file LinksUpdate.php.

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

◆ $mRecursive

bool MediaWiki\Deferred\LinksUpdate\LinksUpdate::$mRecursive

protected

Whether to queue jobs for recursive updates.

Definition at line 71 of file LinksUpdate.php.

◆ $mTitle

Title MediaWiki\Deferred\LinksUpdate\LinksUpdate::$mTitle

protected

Title object of the article linked from.

Definition at line 65 of file LinksUpdate.php.

Referenced by MediaWiki\Deferred\LinksUpdate\LinksDeletionUpdate\doIncrementalUpdate(), and MediaWiki\Deferred\LinksUpdate\LinksUpdate\getTitle().

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

includes/deferred/LinksUpdate/LinksUpdate.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquirePageLock()

◆ doIncrementalUpdate()

◆ doUpdate()

◆ getAddedExternalLinks()

◆ getAddedLinks()

◆ getAddedProperties()

◆ getDB()

◆ getExternalLinksTable()

◆ getImages()

◆ getPageId()

◆ getPageLinksTable()

◆ getPagePropsTable()

◆ getPageReferenceArray()

◆ getPageReferenceIterator()

◆ getParserOutput()

◆ getRemovedExternalLinks()

◆ getRemovedLinks()

◆ getRemovedProperties()

◆ getRevisionRecord()

◆ getTitle()

◆ getTriggeringUser()

◆ isRecursive()

◆ queueRecursiveJobs()

◆ queueRecursiveJobsForTable()

◆ setMoveDetails()

◆ setRevisionRecord()

◆ setStrictTestMode()

◆ setTransactionTicket()

◆ setTriggeringUser()

◆ updateLinksTimestamp()

Member Data Documentation

◆ $mId

◆ $mParserOutput

◆ $mRecursive

◆ $mTitle