Service interface looking up the usage of entities across pages on the local wiki. More...

Inheritance diagram for Wikibase\Client\Usage\UsageLookup:

Public Member Functions
	getUsagesForPage ( $pageId)
	Get the entities used on the given page.

	getPagesUsing (array $entityIds, array $aspects=[])
	Returns the pages that use any of the given entities.

	getUnusedEntities (array $entityIds)
	Returns the elements of $entityIds that are currently not used as far as this UsageTracker knows.

Detailed Description

Service interface looking up the usage of entities across pages on the local wiki.

Member Function Documentation

Wikibase\Client\Usage\UsageLookup::getPagesUsing	(	array	$entityIds,
		array	$aspects = `[]`
	)

Returns the pages that use any of the given entities.

Parameters

EntityId[]	$entityIds
string[]	$aspects	Which aspects to consider (if omitted, all aspects are considered). Use the EntityUsage::XXX_USAGE constants to represent aspects.

Returns: Traversable A traversable over PageEntityUsages of pages using any of the given entities. If $aspects is given, only usages of these aspects are included in the result.

Exceptions

UsageTrackerException

Wikibase\Client\Usage\UsageLookup::getUnusedEntities ( array $entityIds )

Returns the elements of $entityIds that are currently not used as far as this UsageTracker knows.

In other words, this method answers the question which of a given list of entities are currently being used on wiki pages.

Parameters

EntityId[] $entityIds

Exceptions

UsageTrackerException

Wikibase\Client\Usage\UsageLookup::getUsagesForPage ( $pageId )

Get the entities used on the given page.

Parameters

int $pageId

Exceptions

UsageTrackerException

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