Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Lib\Store\TermIndex Interface Reference

Interface to a cache for terms with both write and lookup methods. More...

+ Inheritance diagram for Wikibase\Lib\Store\TermIndex:
+ Collaboration diagram for Wikibase\Lib\Store\TermIndex:

Public Member Functions

 clear ()
 Clears all terms from the cache.
 
- Public Member Functions inherited from Wikibase\Lib\Store\EntityTermStoreWriter
 saveTermsOfEntity (EntityDocument $entity)
 Saves the terms of the provided entity in the term cache.
 
 deleteTermsOfEntity (EntityId $entityId)
 Deletes the terms of the provided entity from the term cache.
 
- Public Member Functions inherited from Wikibase\Lib\Store\LegacyEntityTermStoreReader
 getTermsOfEntity (EntityId $entityId, array $termTypes=null, array $languageCodes=null)
 Returns the terms stored for the given entity.
 
 getTermsOfEntities (array $entityIds, array $termTypes=null, array $languageCodes=null)
 Returns the terms stored for the given entities.
 
- Public Member Functions inherited from Wikibase\Lib\Store\MatchingTermsLookup
 getMatchingTerms (array $criteria, $termType=null, $entityType=null, array $options=[])
 Returns the terms that match the provided conditions.
 
 getTopMatchingTerms (array $criteria, $termType=null, $entityType=null, array $options=[])
 Returns the terms that match the provided conditions ranked with the 'most important' / top first.
 

Detailed Description

Interface to a cache for terms with both write and lookup methods.

Deprecated:
As wb_terms is going away, See https://phabricator.wikimedia.org/T208425
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

◆ clear()

Wikibase\Lib\Store\TermIndex::clear ( )

Clears all terms from the cache.

This is used both with the EntityTermStoreWriter methods and LegacyEntityTermStoreReader. Hence why it lives in this middle ground.

Returns
boolean Success indicator

Implemented in Wikibase\Lib\Store\NullTermIndex, and Wikibase\Lib\Store\Sql\TermSqlIndex.


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