6ba47296d9
There is no way to express that Title::castFromPageIdentity(), Title::castFromPageReference() and Title::castFromLinkTarget() can only return null when the parameter is null. We need to add Phan suppressions or explicit types almost everywhere that these methods are used with parameters that are known to not be null. Instead, introduce new methods Title::newFromPageIdentity() and Title::newFromPageReference() (Title::newFromLinkTarget() already exists), without the null-coalescing behavior, and use them when the parameter is not null. This lets static analysis tools, and humans, easily understand where nulls can't appear. Do the same with the corresponding TitleFactory methods. Change the obvious uses of castFrom*() to newFrom*() (if there is a Phan suppression, a type check, or a method call on the result). Change-Id: Ida4da75953cf3bca372a40dc88022443109ca0cb
88 lines
2.1 KiB
PHP
88 lines
2.1 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
|
|
* @param int $setType
|
|
* @return Title[]
|
|
*/
|
|
public function getTitleArray( $setType ) {
|
|
$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 );
|
|
}
|
|
}
|
|
}
|