MediaWiki  master
MediaWiki\Deferred\LinksUpdate\TemplateLinksTable Class Reference

templatelinks More...

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

Public Member Functions

 __construct (Config $config)
 
 setParserOutput (ParserOutput $parserOutput)
 Subclasses should implement this to extract the data they need from the ParserOutput. More...
 
- 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...
 
 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...
 

Protected Member Functions

 getFromField ()
 Get the name of the field which links to page_id. More...
 
 getFromNamespaceField ()
 
 getNamespaceField ()
 Get the namespace field name. More...
 
 getTableName ()
 Get the table name. More...
 
 getTargetIdField ()
 Get the link target id (DB key) field name. More...
 
 getTitleField ()
 Get the title (DB key) field name. More...
 
 linksTargetNormalizationStage ()
 Normalization stage of the links table (see T222224) More...
 
- 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. 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...
 
 getNewLinkIDs ()
 Get an array (or iterator) of link IDs for the new state. 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...
 
 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...
 
 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...
 
 startUpdate ()
 Subclasses can override this to do any necessary setup before individual write operations begin. More...
 

Additional Inherited Members

- 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...
 
- 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. 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
 

Detailed Description

templatelinks

Since
1.38

Definition at line 14 of file TemplateLinksTable.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::__construct ( Config  $config)

Member Function Documentation

◆ getFromField()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getFromField ( )
protected

Get the name of the field which links to page_id.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 30 of file TemplateLinksTable.php.

◆ getFromNamespaceField()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getFromNamespaceField ( )
protected
Returns
mixed

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 42 of file TemplateLinksTable.php.

◆ getNamespaceField()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getNamespaceField ( )
protected

Get the namespace field name.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 34 of file TemplateLinksTable.php.

◆ getTableName()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getTableName ( )
protected

Get the table name.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 26 of file TemplateLinksTable.php.

◆ getTargetIdField()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getTargetIdField ( )
protected

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

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 46 of file TemplateLinksTable.php.

◆ getTitleField()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::getTitleField ( )
protected

Get the title (DB key) field name.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\GenericPageLinksTable.

Definition at line 38 of file TemplateLinksTable.php.

◆ linksTargetNormalizationStage()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::linksTargetNormalizationStage ( )
protected

Normalization stage of the links table (see T222224)

Returns
int

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 54 of file TemplateLinksTable.php.

◆ setParserOutput()

MediaWiki\Deferred\LinksUpdate\TemplateLinksTable::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.

Parameters
ParserOutput$parserOutput

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 22 of file TemplateLinksTable.php.

References ParserOutput\getTemplates().


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