Inherits MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Collaboration diagram for MediaWiki\Deferred\LinksUpdate\PageLinksTable:

[legend]

Public Member Functions
	setParserOutput (ParserOutput $parserOutput)
	Subclasses should implement this to extract the data they need from the ParserOutput.

Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\TitleLinksTable
	getPageReferenceIterator ( $setType)
	Get a link set as an iterator over PageReferenceValue objects.

	getTitleArray ( $setType)
	Get a link set as an array of Title objects.

Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
	beforeLock ()
	Subclasses can override this to do any necessary setup before the lock is acquired.

	injectBaseDependencies (LBFactory $lbFactory, LinkTargetLookup $linkTargetLookup, PageIdentity $sourcePage, $batchSize)
	This is called by the factory to inject dependencies for the base class.

	setMoveDetails (PageReference $movedPage)
	Notify the object that the operation is a page move, and set the original title.

	setRevision (RevisionRecord $revision)
	Set the revision associated with the edit.

	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)
	Set the empty transaction ticket.

	update ()
	Execute an edit/delete update.

Public Attributes
const	VIRTUAL_DOMAIN = 'virtual-pagelinks'

Public Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
const	CHANGED = 3
	Link type: Changed (inserted or removed) links.

const	DELETED = 2
	Link type: Deleted (removed) links.

const	INSERTED = 1
	Link type: Inserted (added) links.

const	NEW = 5
	Link type: new links (from the ParserOutput)

const	OLD = 4
	Link type: existing/old links.

Protected Member Functions

getFromField ()

Get the name of the field which links to page_id.

Returns: string

getFromNamespaceField ()

Returns: string|null

getNamespaceField ()

Get the namespace field name.

Returns: string

getTableName ()

Get the table name.

Returns: string

getTargetIdField ()

Get the link target id (DB key) field name.

Returns: string

getTitleField ()

Get the title (DB key) field name.

Returns: string

getVirtualDomain ()

Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable

deduplicateLinkIds ( $linkIds)

Given an iterator over link IDs, remove links which go to the same title, leaving only one link per title.

Parameters

iterable<mixed> $linkIds

Returns: iterable<mixed>

deleteLink ( $linkId)

Delete a link identified by ID.The subclass is expected to queue the deletion by calling deleteRow().

Parameters

mixed $linkId

fetchExistingRows ()

Do a select query to fetch the existing rows.

getExistingFields ()

Get the fields to be used in fetchExistingRows().Note that fetchExistingRows() is just a helper for subclasses. The value returned here is effectively private to the subclass.

Returns: array

getExistingLinkIDs ()

Get an array (or iterator) of link IDs for the existing state.The subclass should load the data from the database. There is fetchExistingRows() to make this easier but the subclass is responsible for caching.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

getNewLinkIDs ()

Get an array (or iterator) of link IDs for the new state.See the LinksTable doc comment for an explanation of link IDs.

Returns: iterable<mixed>

insertLink ( $linkId)

Insert a link identified by ID.The subclass is expected to queue the insertion by calling insertRow().

Parameters

mixed $linkId

isExisting ( $linkId)

Determine whether a link (from the new set) is in the existing set.

Parameters

mixed $linkId

Returns: bool

isInNewSet ( $linkId)

Determine whether a link (from the existing set) is in the new set.

Parameters

mixed $linkId

Returns: bool

makePageReferenceValue ( $linkId)

Convert a link ID to a PageReferenceValue.

Parameters

mixed $linkId

Returns: PageReferenceValue

makeTitle ( $linkId)

Convert a link ID to a Title.

Stability: stable: to override

Parameters

mixed $linkId

Returns: Title

needForcedLinkRefresh ()

Subclasses can override this to return true in order to force reinsertion of all the links due to some property of the link changing for reasons not represented by the link ID.

Returns: bool

Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\TitleLinksTable

getDeduplicatedLinkIds ( $setType)

Get link IDs for a given set type, filtering out duplicate links to the same title.

linksTargetNormalizationStage ()

Normalization stage of the links table (see T222224)

Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable

deleteRow ( $conds)

Queue a deletion operation.

doWrites ()

Do the common DB operations.

finishUpdate ()

Subclasses can override this to do any updates associated with their link data, for example dispatching HTML update jobs.

getBatchSize ()

Get the maximum number of rows to update in a batch.

getDB ()

getFromConds ()

Get field=>value associative array for the from field(s)

getInsertOptions ()

Get the options for the insert queries.

getLBFactory ()

getLinkIDs ( $setType)

Get an array or iterator of link IDs of a given type.

getMovedPage ()

Assuming the page was moved, get the original page title before the move.

getRevision ()

Get the RevisionRecord of the new revision, if the LinksUpdate caller injected one.

getSourcePage ()

Get the source page, i.e.

getSourcePageId ()

Get the page_id of the source page.

getTransactionTicket ()

Get the empty transaction ticket, or null if there is none.

insertRow ( $row)

Queue a row for insertion.

isCrossNamespaceMove ()

Determine whether the page was moved to a different namespace.

isMove ()

Determine whether the page was moved.

startUpdate ()

Subclasses can override this to do any necessary setup before individual write operations begin.

virtualDomain ()

What virtual domain should be used to read/write from the table.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable
array	$newLinks = []
	A 2d array representing the new links, with the namespace ID in the first key, the DB key in the second key, and the value arbitrary.

Protected Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
array	$deletedLinks = []
	Link IDs for deleted links.

array	$insertedLinks = []
	Link IDs for inserted links.

LinkTargetLookup	$linkTargetLookup

array	$rowsToDelete = []
	Rows to delete.

array	$rowsToInsert = []
	Rows to insert.

bool	$strictTestMode

Detailed Description

pagelinks

Definition at line 11 of file PageLinksTable.php.

Member Function Documentation

◆ getFromField()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getFromField ( )

protected

Get the name of the field which links to page_id.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 31 of file PageLinksTable.php.

◆ getFromNamespaceField()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getFromNamespaceField ( )

protected

Returns: string|null

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 46 of file PageLinksTable.php.

◆ getNamespaceField()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getNamespaceField ( )

protected

Get the namespace field name.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 36 of file PageLinksTable.php.

◆ getTableName()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getTableName ( )

protected

Get the table name.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 26 of file PageLinksTable.php.

◆ getTargetIdField()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getTargetIdField ( )

protected

Get the link target id (DB key) field name.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 51 of file PageLinksTable.php.

◆ getTitleField()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getTitleField ( )

protected

Get the title (DB key) field name.

Returns: string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 41 of file PageLinksTable.php.

◆ getVirtualDomain()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::getVirtualDomain ( )

protected

Definition at line 56 of file PageLinksTable.php.

◆ setParserOutput()

MediaWiki\Deferred\LinksUpdate\PageLinksTable::setParserOutput ( ParserOutput $parserOutput )

Subclasses should implement this to extract the data they need from the ParserOutput.

To support a future refactor of LinksDeletionUpdate, if this method is not called, the subclass should assume that the new state is empty.

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 14 of file PageLinksTable.php.

References MediaWiki\Parser\ParserOutput\getLinkList().

Member Data Documentation

◆ VIRTUAL_DOMAIN

const MediaWiki\Deferred\LinksUpdate\PageLinksTable::VIRTUAL_DOMAIN = 'virtual-pagelinks'

Definition at line 12 of file PageLinksTable.php.

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

includes/Deferred/LinksUpdate/PageLinksTable.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getFromField()

◆ getFromNamespaceField()

◆ getNamespaceField()

◆ getTableName()

◆ getTargetIdField()

◆ getTitleField()

◆ getVirtualDomain()

◆ setParserOutput()

Member Data Documentation

◆ VIRTUAL_DOMAIN