Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper Class Reference

EntitySearchHelper implementation invoked when federated properties is enabled which uses entity configuration to instantiate the specific handler. More...

+ Inheritance diagram for Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper:
+ Collaboration diagram for Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper:

Public Member Functions

 __construct (EntitySearchHelper $federatedPropertiesEntitySearchHelper, TypeDispatchingEntitySearchHelper $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$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

 

Private Attributes

 $federatedPropertiesEntitySearchHelper
 
 $typeDispatchingEntitySearchHelper
 

Detailed Description

EntitySearchHelper implementation invoked when federated properties is enabled which uses entity configuration to instantiate the specific handler.

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper::__construct ( EntitySearchHelper $federatedPropertiesEntitySearchHelper,
TypeDispatchingEntitySearchHelper $typeDispatchingEntitySearchHelper )

Member Function Documentation

◆ getRankedSearchResults()

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

Implements Wikibase\Repo\Api\EntitySearchHelper.

Member Data Documentation

◆ $federatedPropertiesEntitySearchHelper

Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper::$federatedPropertiesEntitySearchHelper
private

◆ $typeDispatchingEntitySearchHelper

Wikibase\Repo\Api\FedPropertiesTypeDispatchingEntitySearchHelper::$typeDispatchingEntitySearchHelper
private

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