Wikibase
MediaWiki Wikibase extension
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. More...
 
 getSubscribers (EntityId $idToCheck)
 Return the existing subscriptions for given Id to check. More...
 

Detailed Description

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

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$idToCheckEntityId 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$siteIdSite ID of the client site.
EntityId[]$entityIdsThe 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: