Wikibase\Client\Api\ApiListEntityUsage Class Reference

API module to get the usage of entities. More...

Inheritance diagram for Wikibase\Client\Api\ApiListEntityUsage:

Collaboration diagram for Wikibase\Client\Api\ApiListEntityUsage:

Public Member Functions
	__construct (ApiQuery $query, string $moduleName, RepoLinker $repoLinker)
	executeGenerator ( $resultPageSet)
	execute ()
	run (ApiPageSet $resultPageSet=null)
	getCacheMode ( $params)
	doQuery (array $params, ApiPageSet $resultPageSet=null)
	getAllowedParams ()
	getHelpUrls ()

Protected Member Functions
	getExamplesMessages ()

Private Member Functions
	addPageData (object $row)
	formatResult (IResultWrapper $res, int $limit, array $prop, ?ApiPageSet $resultPageSet)
	buildEntry (array &$entry, object $row, bool $url)
	formatPageData (object $row, int $pageId, array $entry, ApiResult $result)
	setContinueFromRow (object $row)
	addContinue (string $continueParam)

Private Attributes
	$repoLinker

Detailed Description

API module to get the usage of entities.

Copyright

GPL-2.0-or-later

Author

Amir Sarabadani < ladsg.nosp@m.roup.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >

Constructor & Destructor Documentation

__construct()

Wikibase\Client\Api\ApiListEntityUsage::__construct	(	ApiQuery	$query,
		string	$moduleName,
		RepoLinker	$repoLinker )

Member Function Documentation

addContinue()

Wikibase\Client\Api\ApiListEntityUsage::addContinue ( string $continueParam )

private

addPageData()

Wikibase\Client\Api\ApiListEntityUsage::addPageData ( object $row )

private

buildEntry()

Wikibase\Client\Api\ApiListEntityUsage::buildEntry ( array & $entry, object $row, bool $url )

private

doQuery()

Wikibase\Client\Api\ApiListEntityUsage::doQuery	(	array	$params,
		ApiPageSet	$resultPageSet = null )

execute()

Wikibase\Client\Api\ApiListEntityUsage::execute

(

)

executeGenerator()

Wikibase\Client\Api\ApiListEntityUsage::executeGenerator

(

$resultPageSet

)

See also

ApiQueryGeneratorBase::executeGenerator

Parameters

ApiPageSet

$resultPageSet

formatPageData()

Wikibase\Client\Api\ApiListEntityUsage::formatPageData ( object $row, int $pageId, array $entry, ApiResult $result )

private

Returns

bool True the result fits into the output, false otherwise

formatResult()

Wikibase\Client\Api\ApiListEntityUsage::formatResult ( IResultWrapper $res, int $limit, array $prop, ?ApiPageSet $resultPageSet )

private

getAllowedParams()

Wikibase\Client\Api\ApiListEntityUsage::getAllowedParams

(

)

getCacheMode()

Wikibase\Client\Api\ApiListEntityUsage::getCacheMode

(

$params

)

See also

ApiQueryBase::getCacheMode

Parameters

array

$params

getExamplesMessages()

Wikibase\Client\Api\ApiListEntityUsage::getExamplesMessages ( )

protected

getHelpUrls()

Wikibase\Client\Api\ApiListEntityUsage::getHelpUrls

(

)

run()

Wikibase\Client\Api\ApiListEntityUsage::run

(

ApiPageSet

$resultPageSet = null

)

setContinueFromRow()

Wikibase\Client\Api\ApiListEntityUsage::setContinueFromRow ( object $row )

private

Member Data Documentation

$repoLinker

Wikibase\Client\Api\ApiListEntityUsage::$repoLinker

private

---

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

• client/includes/Api/ApiListEntityUsage.php