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.

Detailed Description

Generic interface for searching entities.

Copyright

GPL-2.0-or-later

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	$profileContext	indication given to the engine on the context this search is made (might affect ranking)

Returns

TermSearchResult[] Key: string Serialized EntityId

Exceptions

EntitySearchException

when a problem occurs fetching data from the underlying datastore

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

---

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

• repo/includes/Api/EntitySearchHelper.php