Wikibase\Client\Usage\SubscriptionManager Interface Reference

Service interface for tracking subscriptions of clients to entity change events generated on the repo. More...

Inheritance diagram for Wikibase\Client\Usage\SubscriptionManager:

Public Member Functions
	subscribe ( $subscriber, array $entityIds)
	Subscribes the given subscriber to notifications about changes on the specified entities.
	unsubscribe ( $subscriber, array $entityIds)
	Unsubscribes the given subscriber from notifications about changes on the specified entities.

Detailed Description

Service interface for tracking subscriptions of clients to entity change events generated on the repo.

See also

docs/usagetracking.wiki

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Member Function Documentation

subscribe()

Wikibase\Client\Usage\SubscriptionManager::subscribe	(		$subscriber,
		array	$entityIds
	)

Subscribes the given subscriber to notifications about changes on the specified entities.

Parameters

string	$subscriber	Global site ID of the subscriber
EntityId[]	$entityIds	The entities to subscribe to.

Exceptions

UsageTrackerException

Implemented in Wikibase\Client\Usage\NullSubscriptionManager, and Wikibase\Client\Usage\Sql\SqlSubscriptionManager.

unsubscribe()

Wikibase\Client\Usage\SubscriptionManager::unsubscribe	(		$subscriber,
		array	$entityIds
	)

Unsubscribes the given subscriber from notifications about changes on the specified entities.

Parameters

string	$subscriber	Global site ID of the subscriber
EntityId[]	$entityIds	The entities to subscribe to.

Exceptions

UsageTrackerException

Implemented in Wikibase\Client\Usage\NullSubscriptionManager, and Wikibase\Client\Usage\Sql\SqlSubscriptionManager.

---

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

• client/includes/Usage/SubscriptionManager.php