Wikibase
MediaWiki Wikibase extension
Wikibase\Client\Api\ApiClientInfo Class Reference

Provides url and path information for the associated Wikibase repo. More...

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

Public Member Functions

 __construct (SettingsArray $settings, ApiQuery $apiQuery, $moduleName)
 
 execute ()
 
 getCacheMode ( $params)
 

Static Public Member Functions

static factory (ApiQuery $apiQuery, string $moduleName)
 

Protected Member Functions

 getAllowedParams ()
 
 getExamplesMessages ()
 

Private Member Functions

 getInfo (array $params)
 Gets repo url info to inject into the api module. More...
 
 getRepoUrls ()
 

Private Attributes

 $settings
 

Detailed Description

Provides url and path information for the associated Wikibase repo.

Todo:
may want to include namespaces and other settings here too.
Author
Katie Filbert < aude..nosp@m.wiki.nosp@m.@gmai.nosp@m.l.co.nosp@m.m >
Marius Hoch < hoo@o.nosp@m.nlin.nosp@m.e.de >

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Client\Api\ApiClientInfo::__construct ( SettingsArray  $settings,
ApiQuery  $apiQuery,
  $moduleName 
)
Parameters
SettingsArray$settings
ApiQuery$apiQuery
string$moduleName

Member Function Documentation

◆ execute()

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

◆ factory()

static Wikibase\Client\Api\ApiClientInfo::factory ( ApiQuery  $apiQuery,
string  $moduleName 
)
static

◆ getAllowedParams()

Wikibase\Client\Api\ApiClientInfo::getAllowedParams ( )
protected

◆ getCacheMode()

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

◆ getExamplesMessages()

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

◆ getInfo()

Wikibase\Client\Api\ApiClientInfo::getInfo ( array  $params)
private

Gets repo url info to inject into the api module.

Parameters
array$params
Returns
array

◆ getRepoUrls()

Wikibase\Client\Api\ApiClientInfo::getRepoUrls ( )
private
Returns
string[]

Member Data Documentation

◆ $settings

Wikibase\Client\Api\ApiClientInfo::$settings
private

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