wiki.techinc.nl/includes/deferred/LinksUpdate/TitleLinksTable.php
Umherirrender c4c7fc62ec deferred: Hard-deprecate LinksUpdate::getAddedLinks/getRemovedLinks
Also TitleLinksTable::getTitleArray

Depends-On: I7bd6714f31a1a3195c1b9a47c9c49b92b9873212
Depends-On: I9514e77a73eea5ee7fbcf4cda79c8f9c4acbd328
Depends-On: I25d047ceb707837009e0a703693ebc2f49fc0ba9
Change-Id: I00b4363b9af7fef3c5a6ae4f612b37c3cd470d45
2024-07-30 02:10:30 +02:00

89 lines
2.2 KiB
PHP

<?php
namespace MediaWiki\Deferred\LinksUpdate;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Title\Title;
/**
* An abstract base class for tables that link to local titles.
*
* @stable to extend
* @since 1.38
*/
abstract class TitleLinksTable extends LinksTable {
/**
* Convert a link ID to a PageReferenceValue
*
* @param mixed $linkId
* @return PageReferenceValue
*/
abstract protected function makePageReferenceValue( $linkId ): PageReferenceValue;
/**
* Convert a link ID to a Title
*
* @stable to override
* @param mixed $linkId
* @return Title
*/
protected function makeTitle( $linkId ): Title {
return Title::newFromPageReference( $this->makePageReferenceValue( $linkId ) );
}
/**
* Given an iterator over link IDs, remove links which go to the same
* title, leaving only one link per title.
*
* @param iterable<mixed> $linkIds
* @return iterable<mixed>
*/
abstract protected function deduplicateLinkIds( $linkIds );
/**
* Get link IDs for a given set type, filtering out duplicate links to the
* same title.
*
* @param int $setType
* @return iterable<mixed>
*/
protected function getDeduplicatedLinkIds( $setType ) {
$linkIds = $this->getLinkIDs( $setType );
// Only the CHANGED set type should have duplicates
if ( $setType === self::CHANGED ) {
$linkIds = $this->deduplicateLinkIds( $linkIds );
}
return $linkIds;
}
/**
* Get a link set as an array of Title objects. This is memory-inefficient.
*
* @deprecated since 1.38, hard-deprecated since 1.43
* @param int $setType
* @return Title[]
*/
public function getTitleArray( $setType ) {
wfDeprecated( __METHOD__, '1.43' );
$linkIds = $this->getDeduplicatedLinkIds( $setType );
$titles = [];
foreach ( $linkIds as $linkId ) {
$titles[] = $this->makeTitle( $linkId );
}
return $titles;
}
/**
* Get a link set as an iterator over PageReferenceValue objects.
*
* @param int $setType
* @return iterable<PageReferenceValue>
* @phan-return \Traversable
*/
public function getPageReferenceIterator( $setType ) {
$linkIds = $this->getDeduplicatedLinkIds( $setType );
foreach ( $linkIds as $linkId ) {
yield $this->makePageReferenceValue( $linkId );
}
}
}