Wikibase
MediaWiki Wikibase extension
Wikibase\Repo\Api\EntitySearchHelper Interface Reference

Generic interface for searching entities. More...

+ Inheritance diagram for Wikibase\Repo\Api\EntitySearchHelper:

Public Member Functions

 getRankedSearchResults ( $text, $languageCode, $entityType, $limit, $strictLanguage, ?string $profileContext)
 Get entities matching the search term. More...
 

Detailed Description

Generic interface for searching entities.

Member Function Documentation

◆ getRankedSearchResults()

Wikibase\Repo\Api\EntitySearchHelper::getRankedSearchResults (   $text,
  $languageCode,
  $entityType,
  $limit,
  $strictLanguage,
?string  $profileContext 
)

Get entities matching the search term.

Parameters
string$text
string$languageCode
string$entityType
int$limit
bool$strictLanguage
string | null$profileContextindication given to the engine on the context this search is made (might affect ranking)
Returns
TermSearchResult[] Key: string Serialized EntityId
Exceptions
EntitySearchExceptionwhen a problem occurs fetching data from the underlying datastore

Implemented in Wikibase\Repo\FederatedProperties\NullEntitySearchHelper, Wikibase\Repo\FederatedProperties\ApiEntitySearchHelper, Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper, Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper, Wikibase\Repo\Api\EntityTermSearchHelper, Wikibase\Repo\Api\EntityIdSearchHelper, Wikibase\Repo\Api\ConceptUriSearchHelper, and Wikibase\Repo\Api\CombinedEntitySearchHelper.


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