Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper Class Reference

EntitySearchHelper implementation which uses entity configuration to instantiate the specific handler. More...

Inheritance diagram for Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper:

Collaboration diagram for Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper:

Public Member Functions
	__construct (array $callbacks, WebRequest $request)
	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

Private Attributes
	$callbacks
	$request

Detailed Description

EntitySearchHelper implementation which uses entity configuration to instantiate the specific handler.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper::__construct	(	array	$callbacks,
		WebRequest	$request )

Member Function Documentation

getRankedSearchResults()

Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper::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

Implements Wikibase\Repo\Api\EntitySearchHelper.

Member Data Documentation

$callbacks

Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper::$callbacks

private

$request

Wikibase\Repo\Api\TypeDispatchingEntitySearchHelper::$request

private

---

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

• repo/includes/Api/TypeDispatchingEntitySearchHelper.php