Wikibase\Repo\Api\SearchEntities Class Reference

API module to search for Wikibase entities. More...

Inheritance diagram for Wikibase\Repo\Api\SearchEntities:

Collaboration diagram for Wikibase\Repo\Api\SearchEntities:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, LinkBatchFactory $linkBatchFactory, WbSearchEntitiesControllerDispatcher $searchControllerDispatcher, ContentLanguages $termLanguages, EntitySourceLookup $entitySourceLookup, EntityTitleLookup $entityTitleLookup, EntityTitleTextLookup $entityTitleTextLookup, EntityUrlLookup $entityUrlLookup, EntityArticleIdLookup $entityArticleIdLookup, ApiErrorReporter $errorReporter, array $enabledEntityTypes, array $searchProfiles)
	execute ()
	executeInternal ()

Static Public Member Functions
static	factory (ApiMain $mainModule, string $moduleName, LinkBatchFactory $linkBatchFactory, WbSearchEntitiesControllerDispatcher $searchControllerDispatcher, ApiHelperFactory $apiHelperFactory, array $enabledEntityTypes, EntityArticleIdLookup $entityArticleIdLookup, EntitySourceLookup $entitySourceLookup, EntityTitleLookup $entityTitleLookup, EntityTitleTextLookup $entityTitleTextLookup, EntityUrlLookup $entityUrlLookup, SettingsArray $repoSettings, ContentLanguages $termsLanguages)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	getSearchResults (array $params)
	Fetches the requested page of search results together with whether more results exist beyond it (used to emit the search-continue cursor).
	buildTermSearchMatchEntry (TermSearchResult $match, ?array $props)
	buildTermSearchMatchPageEntry (TermSearchResult $match, ?array $props)
	buildTermSearchMatchDisplayEntry (TermSearchResult $match, array $entry)
	getRepositoryOrEntitySourceName (EntityId $entityId)
	getDisplayTerm (Term $term)
	getApiUser ()

Private Attributes
const	CONTINUE_SOFT_LIMIT = self::LIMIT_SML1
	"Soft" limit on the "continue" parameter.
const	CONTINUE_HARD_LIMIT = 10000
	"Hard" limit on the "continue" parameter.
LinkBatchFactory	$linkBatchFactory
WbSearchEntitiesControllerDispatcher	$searchControllerDispatcher
ContentLanguages	$termsLanguages
EntitySourceLookup	$entitySourceLookup
EntityTitleLookup	$entityTitleLookup
EntityTitleTextLookup	$entityTitleTextLookup
EntityUrlLookup	$entityUrlLookup
EntityArticleIdLookup	$entityArticleIdLookup
ApiErrorReporter	$errorReporter
array	$enabledEntityTypes
array	$searchProfiles

Detailed Description

API module to search for Wikibase entities.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\SearchEntities::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		LinkBatchFactory	$linkBatchFactory,
		WbSearchEntitiesControllerDispatcher	$searchControllerDispatcher,
		ContentLanguages	$termLanguages,
		EntitySourceLookup	$entitySourceLookup,
		EntityTitleLookup	$entityTitleLookup,
		EntityTitleTextLookup	$entityTitleTextLookup,
		EntityUrlLookup	$entityUrlLookup,
		EntityArticleIdLookup	$entityArticleIdLookup,
		ApiErrorReporter	$errorReporter,
		array	$enabledEntityTypes,
		array	$searchProfiles )

See also

ApiBase::__construct

Member Function Documentation

buildTermSearchMatchDisplayEntry()

Wikibase\Repo\Api\SearchEntities::buildTermSearchMatchDisplayEntry ( TermSearchResult $match, array $entry )

private

Add matched terms to the aliases key in the result to give some context for the matched Term if the matched term is different to the alias. XXX: This appears odd but is used in the UI / Entity suggesters

buildTermSearchMatchEntry()

Wikibase\Repo\Api\SearchEntities::buildTermSearchMatchEntry ( TermSearchResult $match, ?array $props )

private

Parameters

TermSearchResult	$match
string[] | null	$props

Returns

array

buildTermSearchMatchPageEntry()

Wikibase\Repo\Api\SearchEntities::buildTermSearchMatchPageEntry ( TermSearchResult $match, ?array $props )

private

Parameters

TermSearchResult	$match
string[] | null	$props

The repository key should be deprecated and removed, for now avoid adding it when using federatedProperties to avoid confusion in the new feature and avoid the need to "fix" it.. This is deliberately not tested and thus not injected as for federated properties we "don't care much" and for default Wikibase this is already covered by the SearchEntitiesTest.

execute()

Wikibase\Repo\Api\SearchEntities::execute

(

)

executeInternal()

Wikibase\Repo\Api\SearchEntities::executeInternal

(

)

Exceptions

ApiUsageException
EntitySearchException

factory()

static Wikibase\Repo\Api\SearchEntities::factory ( ApiMain $mainModule, string $moduleName, LinkBatchFactory $linkBatchFactory, WbSearchEntitiesControllerDispatcher $searchControllerDispatcher, ApiHelperFactory $apiHelperFactory, array $enabledEntityTypes, EntityArticleIdLookup $entityArticleIdLookup, EntitySourceLookup $entitySourceLookup, EntityTitleLookup $entityTitleLookup, EntityTitleTextLookup $entityTitleTextLookup, EntityUrlLookup $entityUrlLookup, SettingsArray $repoSettings, ContentLanguages $termsLanguages )

static

getAllowedParams()

Wikibase\Repo\Api\SearchEntities::getAllowedParams ( )

protected

getApiUser()

Wikibase\Repo\Api\SearchEntities::getApiUser ( )

private

getDisplayTerm()

Wikibase\Repo\Api\SearchEntities::getDisplayTerm ( Term $term )

private

getExamplesMessages()

Wikibase\Repo\Api\SearchEntities::getExamplesMessages ( )

protected

getRepositoryOrEntitySourceName()

Wikibase\Repo\Api\SearchEntities::getRepositoryOrEntitySourceName ( EntityId $entityId )

private

getSearchResults()

Wikibase\Repo\Api\SearchEntities::getSearchResults ( array $params )

private

Fetches the requested page of search results together with whether more results exist beyond it (used to emit the search-continue cursor).

Parameters

array

$params

Returns

WbSearchEntitiesResponse

Exceptions

ApiUsageException

Member Data Documentation

$enabledEntityTypes

array Wikibase\Repo\Api\SearchEntities::$enabledEntityTypes

private

$entityArticleIdLookup

EntityArticleIdLookup Wikibase\Repo\Api\SearchEntities::$entityArticleIdLookup

private

$entitySourceLookup

EntitySourceLookup Wikibase\Repo\Api\SearchEntities::$entitySourceLookup

private

$entityTitleLookup

EntityTitleLookup Wikibase\Repo\Api\SearchEntities::$entityTitleLookup

private

$entityTitleTextLookup

EntityTitleTextLookup Wikibase\Repo\Api\SearchEntities::$entityTitleTextLookup

private

$entityUrlLookup

EntityUrlLookup Wikibase\Repo\Api\SearchEntities::$entityUrlLookup

private

$errorReporter

ApiErrorReporter Wikibase\Repo\Api\SearchEntities::$errorReporter

private

$linkBatchFactory

LinkBatchFactory Wikibase\Repo\Api\SearchEntities::$linkBatchFactory

private

$searchControllerDispatcher

WbSearchEntitiesControllerDispatcher Wikibase\Repo\Api\SearchEntities::$searchControllerDispatcher

private

$searchProfiles

array Wikibase\Repo\Api\SearchEntities::$searchProfiles

private

$termsLanguages

ContentLanguages Wikibase\Repo\Api\SearchEntities::$termsLanguages

private

CONTINUE_HARD_LIMIT

const Wikibase\Repo\Api\SearchEntities::CONTINUE_HARD_LIMIT = 10000

private

"Hard" limit on the "continue" parameter.

Past this point, continuation is not allowed (T355251). The value is mostly arbitrary (could be somewhat higher or lower), but chosen to coincide with CirrusSearch's Searcher::MAX_OFFSET_LIMIT: when using CirrusSearch, it's not possible to get more than 10000 search results anyway.

CONTINUE_SOFT_LIMIT

const Wikibase\Repo\Api\SearchEntities::CONTINUE_SOFT_LIMIT = self::LIMIT_SML1

private

"Soft" limit on the "continue" parameter.

Past this point, we won't add it to the response, though users can still ask for higher continuation offsets manually.

---

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

• repo/includes/Api/SearchEntities.php