MediaWiki  master
MediaWiki\Deferred\LinksUpdate\CategoryLinksTable Class Reference

categorylinks More...

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

Public Member Functions

 __construct (LanguageConverterFactory $converterFactory, NamespaceInfo $namespaceInfo, WikiPageFactory $wikiPageFactory, Collation $collation, $collationName, $tableName, $isTempTable)
 
 setParserOutput (ParserOutput $parserOutput)
 Subclasses should implement this to extract the data they need from the ParserOutput. More...
 
 startUpdate ()
 Cache the category type after the source page has been set. 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

 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...
 
 finishUpdate ()
 Subclasses can override this to do any updates associated with their link data, for example dispatching HTML update jobs. More...
 
 getExistingFields ()
 Get the fields to be used in fetchExistingRows(). More...
 
 getExistingLinkIDs ()
 
 getFromField ()
 Get the name of the field which links to page_id. More...
 
 getNewLinkIDs ()
 Get the new link IDs. More...
 
 getTableName ()
 Get the table 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...
 
 fetchExistingRows ()
 Do a select query to fetch the existing rows. 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...
 
 linksTargetNormalizationStage ()
 Normalization stage of the links table (see T222224) 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\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

categorylinks

Link ID format: string[]

  • 0: Category name
  • 1: User-specified sort key (cl_sortkey_prefix)
Since
1.38

Definition at line 24 of file CategoryLinksTable.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::__construct ( LanguageConverterFactory  $converterFactory,
NamespaceInfo  $namespaceInfo,
WikiPageFactory  $wikiPageFactory,
Collation  $collation,
  $collationName,
  $tableName,
  $isTempTable 
)
Parameters
LanguageConverterFactory$converterFactory
NamespaceInfo$namespaceInfo
WikiPageFactory$wikiPageFactory
Collation$collation
string$collationName
string$tableName
bool$isTempTable

Definition at line 77 of file CategoryLinksTable.php.

References MediaWiki\Languages\LanguageConverterFactory\getLanguageConverter().

Member Function Documentation

◆ deduplicateLinkIds()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 251 of file CategoryLinksTable.php.

◆ deleteLink()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 234 of file CategoryLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\deleteRow().

◆ finishUpdate()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::finishUpdate ( )
protected

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

Stability: stable
to override

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 261 of file CategoryLinksTable.php.

◆ getExistingFields()

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

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

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 140 of file CategoryLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\needForcedLinkRefresh().

◆ getExistingLinkIDs()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::getExistingLinkIDs ( )
protected
Returns
\Generator

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 198 of file CategoryLinksTable.php.

◆ getFromField()

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

Get the name of the field which links to page_id.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 136 of file CategoryLinksTable.php.

◆ getNewLinkIDs()

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

Get the new link IDs.

The link ID is a list with the name in the first element and the sort key prefix in the second element.

Returns
iterable<array>

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 154 of file CategoryLinksTable.php.

◆ getTableName()

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

Get the table name.

Returns
string

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 132 of file CategoryLinksTable.php.

◆ insertLink()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 216 of file CategoryLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\getDB(), and MediaWiki\Deferred\LinksUpdate\LinksTable\insertRow().

◆ isExisting()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 204 of file CategoryLinksTable.php.

◆ isInNewSet()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 210 of file CategoryLinksTable.php.

◆ makePageReferenceValue()

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

Convert a link ID to a PageReferenceValue.

Parameters
mixed$linkId
Returns
PageReferenceValue

Reimplemented from MediaWiki\Deferred\LinksUpdate\TitleLinksTable.

Definition at line 243 of file CategoryLinksTable.php.

◆ makeTitle()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 247 of file CategoryLinksTable.php.

◆ needForcedLinkRefresh()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 238 of file CategoryLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\isMove().

Referenced by MediaWiki\Deferred\LinksUpdate\CategoryLinksTable\getExistingFields().

◆ setParserOutput()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::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 103 of file CategoryLinksTable.php.

References Title\castFromPageIdentity(), ParserOutput\getCategories(), MediaWiki\Deferred\LinksUpdate\LinksTable\getSourcePage(), Title\makeTitleSafe(), and NS_CATEGORY.

◆ startUpdate()

MediaWiki\Deferred\LinksUpdate\CategoryLinksTable::startUpdate ( )

Cache the category type after the source page has been set.

Reimplemented from MediaWiki\Deferred\LinksUpdate\LinksTable.

Definition at line 98 of file CategoryLinksTable.php.

References MediaWiki\Deferred\LinksUpdate\LinksTable\getSourcePage().


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