MediaWiki  master
MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable Class Reference

Shared code for pagelinks and templatelinks. More...

Inheritance diagram for MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable:
Collaboration diagram for MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable:

Protected Member Functions

 deduplicateLinkIds ( $linkIds)
 Given an iterator over link IDs, remove links which go to the same title, leaving only one link per title. More...
 
 deleteLink ( $linkId)
 Delete a link identified by ID. More...
 
 fetchExistingRows ()
 Do a select query to fetch the existing rows. More...
 
 getExistingFields ()
 Get the fields to be used in fetchExistingRows(). More...
 
 getExistingLinkIDs ()
 Get an array (or iterator) of link IDs for the existing state. More...
 
 getFromNamespaceField ()
 
 getNamespaceField ()
 Get the namespace field name. More...
 
 getNewLinkIDs ()
 Get an array (or iterator) of link IDs for the new state. More...
 
 getTargetIdField ()
 Get the link target id (DB key) field name. More...
 
 getTitleField ()
 Get the title (DB key) field name. More...
 
 insertLink ( $linkId)
 Insert a link identified by ID. More...
 
 isExisting ( $linkId)
 Determine whether a link (from the new set) is in the existing set. More...
 
 isInNewSet ( $linkId)
 Determine whether a link (from the existing set) is in the new set. More...
 
 makePageReferenceValue ( $linkId)
 Convert a link ID to a PageReferenceValue. More...
 
 makeTitle ( $linkId)
 Convert a link ID to a Title. More...
 
 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. More...
 
- 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. More...
 
- Protected Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
 deleteRow ( $conds)
 Queue a deletion operation. More...
 
 doWrites ()
 Do the common DB operations. More...
 
 finishUpdate ()
 Subclasses can override this to do any updates associated with their link data, for example dispatching HTML update jobs. More...
 
 getBatchSize ()
 Get the maximum number of rows to update in a batch. More...
 
 getDB ()
 
 getFromConds ()
 Get field=>value associative array for the from field(s) More...
 
 getFromField ()
 Get the name of the field which links to page_id. More...
 
 getInsertOptions ()
 Get the options for the insert queries. More...
 
 getLBFactory ()
 
 getLinkIDs ( $setType)
 Get an array or iterator of link IDs of a given type. More...
 
 getMovedPage ()
 Assuming the page was moved, get the original page title before the move. More...
 
 getRevision ()
 Get the RevisionRecord of the new revision, if the LinksUpdate caller injected one. More...
 
 getSourcePage ()
 Get the source page, i.e. More...
 
 getSourcePageId ()
 Get the page_id of the source page. More...
 
 getTableName ()
 Get the table name. More...
 
 getTransactionTicket ()
 Get the empty transaction ticket, or null if there is none. More...
 
 insertRow ( $row)
 Queue a row for insertion. More...
 
 isCrossNamespaceMove ()
 Determine whether the page was moved to a different namespace. More...
 
 isMove ()
 Determine whether the page was moved. More...
 
 linksTargetNormalizationStage ()
 Normalization stage of the links table (see T222224) More...
 
 startUpdate ()
 Subclasses can override this to do any necessary setup before individual write operations begin. More...
 

Protected Attributes

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. More...
 
- Protected Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
array $deletedLinks = []
 Link IDs for deleted links. More...
 
array $insertedLinks = []
 Link IDs for inserted links. More...
 
LinkTargetLookup $linkTargetLookup
 
array $rowsToDelete = []
 Rows to delete. More...
 
array $rowsToInsert = []
 Rows to insert. More...
 
bool $strictTestMode
 

Additional Inherited Members

- Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\TitleLinksTable
 getPageReferenceIterator ( $setType)
 Get a link set as an iterator over PageReferenceValue objects. More...
 
 getTitleArray ( $setType)
 Get a link set as an array of Title objects. More...
 
- Public Member Functions inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
 beforeLock ()
 Subclasses can override this to do any necessary setup before the lock is acquired. More...
 
 injectBaseDependencies (LBFactory $lbFactory, LinkTargetLookup $linkTargetLookup, PageIdentity $sourcePage, $batchSize, $afterUpdateHook)
 This is called by the factory to inject dependencies for the base class. More...
 
 setMoveDetails (PageReference $movedPage)
 Notify the object that the operation is a page move, and set the original title. More...
 
 setParserOutput (ParserOutput $parserOutput)
 Subclasses should implement this to extract the data they need from the ParserOutput. More...
 
 setRevision (RevisionRecord $revision)
 Set the revision associated with the edit. More...
 
 setStrictTestMode ( $mode=true)
 Omit conflict resolution options from the insert query so that testing can confirm that the incremental update logic was correct. More...
 
 setTransactionTicket ( $ticket)
 Set the empty transaction ticket. More...
 
 update ()
 Execute an edit/delete update. More...
 
- Public Attributes inherited from MediaWiki\Deferred\LinksUpdate\LinksTable
const CHANGED = 3
 Link type: Changed (inserted or removed) links. More...
 
const DELETED = 2
 Link type: Deleted (removed) links. More...
 
const INSERTED = 1
 Link type: Inserted (added) links. More...
 
const NEW = 5
 Link type: new links (from the ParserOutput) More...
 
const OLD = 4
 Link type: existing/old links. More...
 

Detailed Description

Shared code for pagelinks and templatelinks.

They are very similar tables since they both link to an arbitrary page identified by namespace and title.

Link ID format: string[]:

  • 0: namespace ID
  • 1: title DB key
Since
1.38

Definition at line 20 of file GenericPageLinksTable.php.

Member Function Documentation

◆ deduplicateLinkIds()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::deduplicateLinkIds (   $linkIds)
protected

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>

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 179 of file GenericPageLinksTable.php.

◆ deleteLink()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::deleteLink (   $linkId)
protected

Delete a link identified by ID.

The subclass is expected to queue the deletion by calling deleteRow().

Parameters
mixed$linkId

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 151 of file GenericPageLinksTable.php.

References SCHEMA_COMPAT_WRITE_NEW, and SCHEMA_COMPAT_WRITE_OLD.

◆ fetchExistingRows()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::fetchExistingRows ( )
protected

Do a select query to fetch the existing rows.

This is a helper for subclasses.

Returns
IResultWrapper

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 92 of file GenericPageLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable\getTargetIdField().

◆ getExistingFields()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getExistingFields ( )
protected

◆ getExistingLinkIDs()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getExistingLinkIDs ( )
protected

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>

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 116 of file GenericPageLinksTable.php.

◆ getFromNamespaceField()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getFromNamespaceField ( )
abstractprotected

◆ getNamespaceField()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getNamespaceField ( )
abstractprotected

◆ getNewLinkIDs()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getNewLinkIDs ( )
protected

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>

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 108 of file GenericPageLinksTable.php.

◆ getTargetIdField()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getTargetIdField ( )
abstractprotected

◆ getTitleField()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::getTitleField ( )
abstractprotected

◆ insertLink()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::insertLink (   $linkId)
protected

Insert a link identified by ID.

The subclass is expected to queue the insertion by calling insertRow().

Parameters
mixed$linkId

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 134 of file GenericPageLinksTable.php.

References getDB(), SCHEMA_COMPAT_WRITE_NEW, and SCHEMA_COMPAT_WRITE_OLD.

◆ isExisting()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::isExisting (   $linkId)
protected

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

Parameters
mixed$linkId
Returns
bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 124 of file GenericPageLinksTable.php.

◆ isInNewSet()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::isInNewSet (   $linkId)
protected

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

Parameters
mixed$linkId
Returns
bool

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 129 of file GenericPageLinksTable.php.

◆ makePageReferenceValue()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::makePageReferenceValue (   $linkId)
protected

Convert a link ID to a PageReferenceValue.

Parameters
mixed$linkId
Returns
PageReferenceValue

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 171 of file GenericPageLinksTable.php.

◆ makeTitle()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::makeTitle (   $linkId)
protected

Convert a link ID to a Title.

Stability: stable
to override
Parameters
mixed$linkId
Returns
Title

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 175 of file GenericPageLinksTable.php.

◆ needForcedLinkRefresh()

MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::needForcedLinkRefresh ( )
protected

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

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 167 of file GenericPageLinksTable.php.

Member Data Documentation

◆ $newLinks

array MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable::$newLinks = []
protected

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.

Definition at line 27 of file GenericPageLinksTable.php.


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