Wikibase
MediaWiki Wikibase extension
Wikibase\Repo\Api\ListSubscribers Class Reference

API module for getting wikis subscribed to changes to given entities. More...

+ Inheritance diagram for Wikibase\Repo\Api\ListSubscribers:
+ Collaboration diagram for Wikibase\Repo\Api\ListSubscribers:

Public Member Functions

 __construct (ApiQuery $mainModule, string $moduleName, ApiErrorReporter $errorReporter, EntityIdParser $idParser, SiteLookup $siteLookup)
 
 execute ()
 
 doQuery (array $idStrings, ?string $continue, int $limit)
 
 getCacheMode ( $params)
 

Static Public Member Functions

static factory (ApiQuery $apiQuery, string $moduleName, SiteLookup $siteLookup, ApiHelperFactory $apiHelperFactory, EntityIdParser $entityIdParser)
 

Protected Member Functions

 getAllowedParams ()
 
 getExamplesMessages ()
 

Private Member Functions

 addContinue (string $continueParam)
 
 formatResult (IResultWrapper $res, int $limit, array $props)
 
 setContinueFromRow (stdClass $row)
 
 getSubscriber (stdClass $row, bool $url)
 
 getEntityUsageUrl (string $subscription, string $entityIdString)
 

Private Attributes

 $errorReporter
 
 $idParser
 
 $siteLookup
 

Detailed Description

API module for getting wikis subscribed to changes to given entities.

Author
Amir Sarabadani ladsg.nosp@m.roup.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\Api\ListSubscribers::__construct ( ApiQuery  $mainModule,
string  $moduleName,
ApiErrorReporter  $errorReporter,
EntityIdParser  $idParser,
SiteLookup  $siteLookup 
)
Parameters
ApiQuery$mainModule
string$moduleName
ApiErrorReporter$errorReporter
EntityIdParser$idParser
SiteLookup$siteLookup
See also
ApiBase::__construct

Member Function Documentation

◆ addContinue()

Wikibase\Repo\Api\ListSubscribers::addContinue ( string  $continueParam)
private
Parameters
string$continueParam

◆ doQuery()

Wikibase\Repo\Api\ListSubscribers::doQuery ( array  $idStrings,
?string  $continue,
int  $limit 
)
Parameters
string[]$idStrings
string | null$continue
int$limit
Returns
IResultWrapper

◆ execute()

Wikibase\Repo\Api\ListSubscribers::execute ( )

◆ factory()

static Wikibase\Repo\Api\ListSubscribers::factory ( ApiQuery  $apiQuery,
string  $moduleName,
SiteLookup  $siteLookup,
ApiHelperFactory  $apiHelperFactory,
EntityIdParser  $entityIdParser 
)
static

◆ formatResult()

Wikibase\Repo\Api\ListSubscribers::formatResult ( IResultWrapper  $res,
int  $limit,
array  $props 
)
private
Parameters
IResultWrapper$res
int$limit
array$props

◆ getAllowedParams()

Wikibase\Repo\Api\ListSubscribers::getAllowedParams ( )
protected

◆ getCacheMode()

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

◆ getEntityUsageUrl()

Wikibase\Repo\Api\ListSubscribers::getEntityUsageUrl ( string  $subscription,
string  $entityIdString 
)
private
Parameters
string$subscription
string$entityIdString
Returns
null|string

◆ getExamplesMessages()

Wikibase\Repo\Api\ListSubscribers::getExamplesMessages ( )
protected

◆ getSubscriber()

Wikibase\Repo\Api\ListSubscribers::getSubscriber ( stdClass  $row,
bool  $url 
)
private
Parameters
stdClass$row
bool$url
Returns
string[]

◆ setContinueFromRow()

Wikibase\Repo\Api\ListSubscribers::setContinueFromRow ( stdClass  $row)
private
Parameters
stdClass$row

Member Data Documentation

◆ $errorReporter

Wikibase\Repo\Api\ListSubscribers::$errorReporter
private

◆ $idParser

Wikibase\Repo\Api\ListSubscribers::$idParser
private

◆ $siteLookup

Wikibase\Repo\Api\ListSubscribers::$siteLookup
private

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