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, $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 ( $row)
	formatResult (IResultWrapper $res, $limit, array $prop, ApiPageSet $resultPageSet=null)
	buildEntry (&$entry, $row, $url)
	formatPageData ( $row, $pageId, array $entry, $result)
	setContinueFromRow ( $row)
	addContinue ( $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,
			$moduleName,
		RepoLinker	$repoLinker
	)

Parameters

ApiQuery	$query
string	$moduleName
RepoLinker	$repoLinker

Member Function Documentation

addContinue()

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

private

Parameters

string

$continueParam

addPageData()

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

private

Parameters

object

$row

Returns

array

buildEntry()

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

private

Parameters

array	$entry
object	$row
bool	$url

doQuery()

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

Parameters

array	$params
ApiPageSet | null	$resultPageSet

Returns

IResultWrapper|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 (   $row,   $pageId, array  $entry,   $result  )

private

Parameters

object	$row
int | string	$pageId
array	$entry
object	$result

Returns

bool

formatResult()

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

private

Parameters

IResultWrapper	$res
int	$limit
array	$prop
ApiPageSet | null	$resultPageSet

getAllowedParams()

Wikibase\Client\Api\ApiListEntityUsage::getAllowedParams

(

)

getCacheMode()

Wikibase\Client\Api\ApiListEntityUsage::getCacheMode

(

$params

)

See also

ApiQueryBase::getCacheMode

Parameters

array

$params

Returns

string

getExamplesMessages()

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

protected

getHelpUrls()

Wikibase\Client\Api\ApiListEntityUsage::getHelpUrls

(

)

run()

Wikibase\Client\Api\ApiListEntityUsage::run

(

ApiPageSet

$resultPageSet = null

)

Parameters

ApiPageSet | null

$resultPageSet

setContinueFromRow()

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

private

Parameters

object

$row

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