Wikibase\Repo\Api\QuerySearchEntities Class Reference

API module to search for Wikibase entities that can be used as a generator. More...

Inheritance diagram for Wikibase\Repo\Api\QuerySearchEntities:

Collaboration diagram for Wikibase\Repo\Api\QuerySearchEntities:

Public Member Functions
	__construct (ApiQuery $apiQuery, string $moduleName, EntitySearchHelper $entitySearchHelper, EntityTitleLookup $titleLookup, ContentLanguages $termsLanguages, array $entityTypes)
	execute ()
	executeGenerator ( $resultPageSet)
	getCacheMode ( $params)
	isInternal ()

Static Public Member Functions
static	factory (ApiQuery $apiQuery, string $moduleName, array $enabledEntityTypes, array $entitySearchHelperCallbacks, EntityTitleLookup $entityTitleLookup, ContentLanguages $termsLanguages)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	getSearchResults (array $params)

Private Attributes
	$entitySearchHelper
	$titleLookup
	$termsLanguages
	$entityTypes

Detailed Description

API module to search for Wikibase entities that can be used as a generator.

Copyright

GPL-2.0-or-later

Author

Bene* < benes.nosp@m.tar..nosp@m.wikim.nosp@m.edia.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\QuerySearchEntities::__construct	(	ApiQuery	$apiQuery,
		string	$moduleName,
		EntitySearchHelper	$entitySearchHelper,
		EntityTitleLookup	$titleLookup,
		ContentLanguages	$termsLanguages,
		array	$entityTypes
	)

Parameters

ApiQuery	$apiQuery
string	$moduleName
EntitySearchHelper	$entitySearchHelper
EntityTitleLookup	$titleLookup
ContentLanguages	$termsLanguages
array	$entityTypes

Member Function Documentation

execute()

Wikibase\Repo\Api\QuerySearchEntities::execute

(

)

executeGenerator()

Wikibase\Repo\Api\QuerySearchEntities::executeGenerator

(

$resultPageSet

)

Parameters

ApiPageSet

$resultPageSet

factory()

static Wikibase\Repo\Api\QuerySearchEntities::factory ( ApiQuery  $apiQuery, string  $moduleName, array  $enabledEntityTypes, array  $entitySearchHelperCallbacks, EntityTitleLookup  $entityTitleLookup, ContentLanguages  $termsLanguages  )

static

getAllowedParams()

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

protected

getCacheMode()

Wikibase\Repo\Api\QuerySearchEntities::getCacheMode

(

$params

)

See also

ApiQueryBase::getCacheMode

Parameters

array

$params

Returns

string

getExamplesMessages()

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

protected

getSearchResults()

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

private

Parameters

array

$params

Returns

TermSearchResult[]

Exceptions

isInternal()

Wikibase\Repo\Api\QuerySearchEntities::isInternal

(

)

Member Data Documentation

$entitySearchHelper

Wikibase\Repo\Api\QuerySearchEntities::$entitySearchHelper

private

$entityTypes

Wikibase\Repo\Api\QuerySearchEntities::$entityTypes

private

$termsLanguages

Wikibase\Repo\Api\QuerySearchEntities::$termsLanguages

private

$titleLookup

Wikibase\Repo\Api\QuerySearchEntities::$titleLookup

private

---

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

• repo/includes/Api/QuerySearchEntities.php