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. | |
| 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
Methods helping search interactors from a term store.
- Copyright
- GPL-2.0-or-later
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 $options Accepted 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\NullTermIndex, Wikibase\Lib\Store\Sql\Terms\DatabaseMatchingTermsLookup, Wikibase\Lib\Store\Sql\Terms\TermStoreDelegatingMatchingTermsLookup, and Wikibase\Lib\Store\Sql\TermSqlIndex.
◆ getTopMatchingTerms()
| Wikibase\Lib\Store\MatchingTermsLookup::getTopMatchingTerms | ( | array | $criteria, |
$termType = null, |
|||
$entityType = null, |
|||
| array | $options = [] |
||
| ) |
Returns the terms that match the provided conditions ranked with the 'most important' / top first.
Will only return one TermIndexEntry per Entity
$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 $options Accepted options are: - caseSensitive: boolean, default true
- prefixSearch: boolean, default false
- LIMIT: int, defaults to none
- Returns
- TermIndexEntry[]
Implemented in Wikibase\Lib\Store\NullTermIndex, Wikibase\Lib\Store\Sql\Terms\DatabaseMatchingTermsLookup, Wikibase\Lib\Store\Sql\Terms\TermStoreDelegatingMatchingTermsLookup, and Wikibase\Lib\Store\Sql\TermSqlIndex.
The documentation for this interface was generated from the following file:
- lib/includes/Store/MatchingTermsLookup.php
