Wikibase\Client\Usage\ParserOutputUsageAccumulator Class Reference
This implementation of the UsageAccumulator interface acts as a wrapper around a ParserOutput object. More...
Inheritance diagram for Wikibase\Client\Usage\ParserOutputUsageAccumulator:
Collaboration diagram for Wikibase\Client\Usage\ParserOutputUsageAccumulator:
Public Member Functions | |
| __construct (ParserOutput $parserOutput, EntityUsageFactory $entityUsageFactory, UsageDeduplicator $deduplicator) | |
| addUsage (EntityUsage $usage) | |
| getUsages () | |
| Public Member Functions inherited from Wikibase\Client\Usage\UsageAccumulator | |
| 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, i.e. More... | |
| addSiteLinksUsage (EntityId $id) | |
| Registers the usage of an entity's sitelinks, e.g. More... | |
| addStatementUsage (EntityId $id, NumericPropertyId $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... | |
Public Attributes | |
| const | EXTENSION_DATA_KEY = 'wikibase-entity-usage' |
Private Attributes | |
| $parserOutput | |
| $entityUsageFactory | |
| $usageDeduplicator | |
Detailed Description
This implementation of the UsageAccumulator interface acts as a wrapper around a ParserOutput object.
Thus, this class encapsulates the knowledge about how usage is tracked in the ParserOutput.
- Copyright
- GPL-2.0-or-later
Constructor & Destructor Documentation
◆ __construct()
| Wikibase\Client\Usage\ParserOutputUsageAccumulator::__construct | ( | ParserOutput | $parserOutput, |
| EntityUsageFactory | $entityUsageFactory, | ||
| UsageDeduplicator | $deduplicator | ||
| ) |
Member Function Documentation
◆ addUsage()
| Wikibase\Client\Usage\ParserOutputUsageAccumulator::addUsage | ( | EntityUsage | $usage | ) |
- See also
- UsageAccumulator::addUsage
- Parameters
-
EntityUsage $usage
Reimplemented from Wikibase\Client\Usage\UsageAccumulator.
◆ getUsages()
| Wikibase\Client\Usage\ParserOutputUsageAccumulator::getUsages | ( | ) |
- See also
- UsageAccumulator::getUsage
- Returns
- EntityUsage[]
Reimplemented from Wikibase\Client\Usage\UsageAccumulator.
Member Data Documentation
◆ $entityUsageFactory
|
private |
◆ $parserOutput
|
private |
◆ $usageDeduplicator
|
private |
◆ EXTENSION_DATA_KEY
| const Wikibase\Client\Usage\ParserOutputUsageAccumulator::EXTENSION_DATA_KEY = 'wikibase-entity-usage' |
The documentation for this class was generated from the following file:
- client/includes/Usage/ParserOutputUsageAccumulator.php
