Wikibase
MediaWiki Wikibase extension
Wikibase\Client\Usage\UsageAccumulator Class Reference

Interface and base class for objects accumulating usage tracking information for a given page. More...

+ Inheritance diagram for Wikibase\Client\Usage\UsageAccumulator:

Public Member Functions

 addUsage (EntityUsage $usage)
 Registers usage of the given aspect of the given entity. More...
 
 addLabelUsage (EntityId $id, $languageCode=null)
 Registers the usage of an entity's label (in the given language). More...
 
 addDescriptionUsage (EntityId $id, $languageCode=null)
 Registers the usage of an entity's description (in the given language). More...
 
 addTitleUsage (EntityId $id)
 Registers the usage of an entity's local page title, e.g. More...
 
 addSiteLinksUsage (EntityId $id)
 Registers the usage of an entity's sitelinks, e.g. More...
 
 addStatementUsage (EntityId $id, PropertyId $propertyId)
 Registers the usage of statements from an entity (identified by their property id). More...
 
 addOtherUsage (EntityId $id)
 Registers the usage of other (i.e. More...
 
 addAllUsage (EntityId $id)
 Registers the usage of any/all data of an entity (e.g. More...
 
 getUsages ()
 Returns all entity usages previously registered via addXxxUsage() More...
 

Detailed Description

Interface and base class for objects accumulating usage tracking information for a given page.

Author
Daniel Kinzler
Thiemo Kreuz

Member Function Documentation

◆ addAllUsage()

Wikibase\Client\Usage\UsageAccumulator::addAllUsage ( EntityId  $id)

Registers the usage of any/all data of an entity (e.g.

when accessed programmatically using Lua).

Parameters
EntityId$id

◆ addDescriptionUsage()

Wikibase\Client\Usage\UsageAccumulator::addDescriptionUsage ( EntityId  $id,
  $languageCode = null 
)

Registers the usage of an entity's description (in the given language).

Parameters
EntityId$id
string | null$languageCode

◆ addLabelUsage()

Wikibase\Client\Usage\UsageAccumulator::addLabelUsage ( EntityId  $id,
  $languageCode = null 
)

Registers the usage of an entity's label (in the given language).

Parameters
EntityId$id
string | null$languageCode

◆ addOtherUsage()

Wikibase\Client\Usage\UsageAccumulator::addOtherUsage ( EntityId  $id)

Registers the usage of other (i.e.

not label, sitelink, or title) of an entity (e.g. access to statements or labels in labels a language other than the content language).

Parameters
EntityId$id

◆ addSiteLinksUsage()

Wikibase\Client\Usage\UsageAccumulator::addSiteLinksUsage ( EntityId  $id)

Registers the usage of an entity's sitelinks, e.g.

to generate language links.

Parameters
EntityId$id

◆ addStatementUsage()

Wikibase\Client\Usage\UsageAccumulator::addStatementUsage ( EntityId  $id,
PropertyId  $propertyId 
)

Registers the usage of statements from an entity (identified by their property id).

Parameters
EntityId$id
PropertyId$propertyIdThe PropertyId of Statements that are used.

◆ addTitleUsage()

Wikibase\Client\Usage\UsageAccumulator::addTitleUsage ( EntityId  $id)

Registers the usage of an entity's local page title, e.g.

to refer to the corresponding page on the local wiki.

Parameters
EntityId$id

◆ addUsage()

Wikibase\Client\Usage\UsageAccumulator::addUsage ( EntityUsage  $usage)
abstract

Registers usage of the given aspect of the given entity.

Parameters
EntityUsage$usage

Reimplemented in Wikibase\Client\Usage\ParserOutputUsageAccumulator, and Wikibase\Client\Usage\HashUsageAccumulator.

◆ getUsages()

Wikibase\Client\Usage\UsageAccumulator::getUsages ( )
abstract

Returns all entity usages previously registered via addXxxUsage()

Returns
EntityUsage[]

Reimplemented in Wikibase\Client\Usage\ParserOutputUsageAccumulator, and Wikibase\Client\Usage\HashUsageAccumulator.


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