Wikibase\Repo\Store\SubscriptionLookup Interface Reference

Interface for looking up which client is interested in changes to which entity. More...

Inheritance diagram for Wikibase\Repo\Store\SubscriptionLookup:

Public Member Functions
	getSubscriptions ( $siteId, array $entityIds)
	Filters a list of EntityIDs, returning the ones that the given client site is subscribed to.
	getSubscribers (EntityId $idToCheck)
	Return the existing subscriptions for given Id to check.

Detailed Description

Interface for looking up which client is interested in changes to which entity.

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Member Function Documentation

getSubscribers()

Wikibase\Repo\Store\SubscriptionLookup::getSubscribers

(

EntityId

$idToCheck

)

Return the existing subscriptions for given Id to check.

Parameters

EntityId

$idToCheck

EntityId to get subscribers

Returns

string[] wiki IDs of wikis subscribed to the given entity

Implemented in Wikibase\Repo\Store\Sql\SqlSubscriptionLookup.

getSubscriptions()

Wikibase\Repo\Store\SubscriptionLookup::getSubscriptions	(		$siteId,
		array	$entityIds
	)

Filters a list of EntityIDs, returning the ones that the given client site is subscribed to.

Parameters

string	$siteId	Site ID of the client site.
EntityId[]	$entityIds	The entities we are interested in.

Returns

EntityId[] a list of entity IDs the client wiki is subscribed to. The result is limited to entity ids also present in $entityIds, if given.

Implemented in Wikibase\Repo\Store\Sql\SqlSubscriptionLookup.

---

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

• repo/includes/Store/SubscriptionLookup.php