Wikibase
MediaWiki Wikibase extension
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Wikibase\Client\Api\ApiPropsEntityUsage Class Reference

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

+ Inheritance diagram for Wikibase\Client\Api\ApiPropsEntityUsage:
+ Collaboration diagram for Wikibase\Client\Api\ApiPropsEntityUsage:

Public Member Functions

 __construct (ApiQuery $query, $moduleName, RepoLinker $repoLinker)
 
 execute ()
 
 getCacheMode ( $params)
 
 doQuery (array $params)
 
 getAllowedParams ()
 
 getHelpUrls ()
 

Protected Member Functions

 getExamplesMessages ()
 

Private Member Functions

 formatResult (IResultWrapper $res, $limit, array $prop)
 
 setContinueFromRow ( $row)
 

Private Attributes

 $repoLinker = null
 

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\ApiPropsEntityUsage::__construct ( ApiQuery  $query,
  $moduleName,
RepoLinker  $repoLinker 
)
Parameters
ApiQuery$query
string$moduleName
RepoLinker$repoLinker

Member Function Documentation

◆ doQuery()

Wikibase\Client\Api\ApiPropsEntityUsage::doQuery ( array  $params)
Parameters
array$params
Returns
IResultWrapper|null

◆ execute()

Wikibase\Client\Api\ApiPropsEntityUsage::execute ( )

◆ formatResult()

Wikibase\Client\Api\ApiPropsEntityUsage::formatResult ( IResultWrapper  $res,
  $limit,
array  $prop 
)
private
Parameters
IResultWrapper$res
int$limit
array$prop

◆ getAllowedParams()

Wikibase\Client\Api\ApiPropsEntityUsage::getAllowedParams ( )

◆ getCacheMode()

Wikibase\Client\Api\ApiPropsEntityUsage::getCacheMode (   $params)
See also
ApiQueryBase::getCacheMode
Parameters
array$params
Returns
string

◆ getExamplesMessages()

Wikibase\Client\Api\ApiPropsEntityUsage::getExamplesMessages ( )
protected

◆ getHelpUrls()

Wikibase\Client\Api\ApiPropsEntityUsage::getHelpUrls ( )

◆ setContinueFromRow()

Wikibase\Client\Api\ApiPropsEntityUsage::setContinueFromRow (   $row)
private
Parameters
object$row

Member Data Documentation

◆ $repoLinker

Wikibase\Client\Api\ApiPropsEntityUsage::$repoLinker = null
private
The documentation for this class was generated from the following file: