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

Methods helping search interactors from a term store. More...

+ Inheritance diagram for Wikibase\Lib\Store\MatchingTermsLookup:

Public Member Functions

 getMatchingTerms (array $criteria, $termType=null, $entityType=null, array $options=[])
 Returns the terms that match the provided conditions.
 

Detailed Description

Methods helping search interactors from a term store.

Member Function Documentation

◆ getMatchingTerms()

Wikibase\Lib\Store\MatchingTermsLookup::getMatchingTerms ( array  $criteria,
  $termType = null,
  $entityType = null,
array  $options = [] 
)

Returns the terms that match the provided conditions.

$terms is an array of Term objects. Terms are joined by OR. The fields of the terms are joined by AND.

A default can be provided for termType and entityType via the corresponding method parameters.

Parameters
TermIndexSearchCriteria[]$criteria
string | string[] | null$termType
string | string[] | null$entityType
array$optionsAccepted options are:
  • caseSensitive: boolean, default true
  • prefixSearch: boolean, default false
  • LIMIT: int, defaults to none
  • orderByWeight: boolean, default false
Returns
TermIndexEntry[]

Implemented in Wikibase\Lib\Store\Sql\Terms\DatabaseMatchingTermsLookup.


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