Wikibase\Client\Changes\AffectedPagesFinder Class Reference

Public Member Functions
	__construct (UsageLookup $usageLookup, TitleFactory $titleFactory, LinkBatchFactory $linkBatchFactory, string $siteId, ?LoggerInterface $logger=null, bool $checkPageExistence=true)
	getAffectedUsagesByPage (Change $change)
	getChangedAspects (EntityChange $change)

Private Member Functions
	getChangedStatementAspects (array $diff)
	getChangedTermAspects ( $aspect, array $diff)
	getAffectedPages (EntityChange $change)
	Returns the page updates implied by the given the change. More...
	mergeUsagesInto (iterable $from, array &$into)
	getPagesReferencedInDiff (array $siteLinkDiff)
	isBadgesOnlyChange (array $siteLinkDiff)
	getTitlesFromTexts (array $names)
	makeVirtualUsages (array $titles, EntityId $entityId, array $aspects)
	transformAllPageEntityUsages (iterable $usages, EntityId $entityId, array $changedAspects)

Private Attributes
	$usageLookup
	$titleFactory
	$linkBatchFactory
	$siteId
	$logger
	$checkPageExistence

Detailed Description

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Katie Filbert < aude..nosp@m.wiki.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >

Constructor & Destructor Documentation

__construct()

Wikibase\Client\Changes\AffectedPagesFinder::__construct	(	UsageLookup	$usageLookup,
		TitleFactory	$titleFactory,
		LinkBatchFactory	$linkBatchFactory,
		string	$siteId,
		?LoggerInterface	$logger = null,
		bool	$checkPageExistence = true
	)

Parameters

UsageLookup	$usageLookup
TitleFactory	$titleFactory
LinkBatchFactory	$linkBatchFactory
string	$siteId
LoggerInterface | null	$logger
bool	$checkPageExistence	To disable slow filtering that is not relevant in test scenarios. Not meant to be used in production!

Exceptions

InvalidArgumentException

Member Function Documentation

getAffectedPages()

Wikibase\Client\Changes\AffectedPagesFinder::getAffectedPages ( EntityChange  $change )

private

Returns the page updates implied by the given the change.

Parameters

EntityChange

$change

Returns

Traversable of PageEntityUsages

See also

Usage tracking for details about virtual usages

getAffectedUsagesByPage()

Wikibase\Client\Changes\AffectedPagesFinder::getAffectedUsagesByPage

(

Change

$change

)

Parameters

Change

$change

Returns

PageEntityUsages[]

getChangedAspects()

Wikibase\Client\Changes\AffectedPagesFinder::getChangedAspects

(

EntityChange

$change

)

Parameters

EntityChange

$change

Returns

string[]

getChangedStatementAspects()

Wikibase\Client\Changes\AffectedPagesFinder::getChangedStatementAspects ( array  $diff )

private

Parameters

string[]

$diff

Returns

string[]

getChangedTermAspects()

Wikibase\Client\Changes\AffectedPagesFinder::getChangedTermAspects (   $aspect, array  $diff  )

private

Parameters

string	$aspect
string[]	$diff

Returns

string[]

getPagesReferencedInDiff()

Wikibase\Client\Changes\AffectedPagesFinder::getPagesReferencedInDiff ( array  $siteLinkDiff )

private

Parameters

array[]

$siteLinkDiff

Exceptions

UnexpectedValueException

Returns

string[]

getTitlesFromTexts()

Wikibase\Client\Changes\AffectedPagesFinder::getTitlesFromTexts ( array  $names )

private

Parameters

string[]

$names

Returns

Title[]

isBadgesOnlyChange()

Wikibase\Client\Changes\AffectedPagesFinder::isBadgesOnlyChange ( array  $siteLinkDiff )

private

Parameters

array

$siteLinkDiff

Returns

bool

makeVirtualUsages()

Wikibase\Client\Changes\AffectedPagesFinder::makeVirtualUsages ( array  $titles, EntityId  $entityId, array  $aspects  )

private

Parameters

Title[]	$titles
EntityId	$entityId
string[]	$aspects

Returns

PageEntityUsages[]

mergeUsagesInto()

Wikibase\Client\Changes\AffectedPagesFinder::mergeUsagesInto ( iterable  $from, array &  $into  )

private

Parameters

	iterable<PageEntityUsages>	$from
PageEntityUsages[]	&$into	Array to merge into

transformAllPageEntityUsages()

Wikibase\Client\Changes\AffectedPagesFinder::transformAllPageEntityUsages ( iterable  $usages, EntityId  $entityId, array  $changedAspects  )

private

Parameters

	iterable<PageEntityUsages>	$usages
EntityId	$entityId
string[]	$changedAspects

Returns

iterable<PageEntityUsages>

Member Data Documentation

$checkPageExistence

Wikibase\Client\Changes\AffectedPagesFinder::$checkPageExistence

private

$linkBatchFactory

Wikibase\Client\Changes\AffectedPagesFinder::$linkBatchFactory

private

$logger

Wikibase\Client\Changes\AffectedPagesFinder::$logger

private

$siteId

Wikibase\Client\Changes\AffectedPagesFinder::$siteId

private

$titleFactory

Wikibase\Client\Changes\AffectedPagesFinder::$titleFactory

private

$usageLookup

Wikibase\Client\Changes\AffectedPagesFinder::$usageLookup

private

---

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

• client/includes/Changes/AffectedPagesFinder.php