Wikibase\Lib\Modules\SitesModule Class Reference

Inheritance diagram for Wikibase\Lib\Modules\SitesModule:

Collaboration diagram for Wikibase\Lib\Modules\SitesModule:

Public Member Functions
	__construct (?SettingsArray $clientSettings, ?SettingsArray $repoSettings, SiteLookup $siteLookup, BagOStuff $cache)
	getScript (ResourceLoaderContext $context)
	Used to propagate information about sites to JavaScript.
	enableModuleContentVersion ()

Public Attributes
const	SITE_DETAILS_TTL = 3600
	How many seconds the result of getSiteDetails() is cached.

Private Member Functions
	getSetting (string $settingName)
	Get a setting from the repo or client settings, with repo overriding client.
	computeSiteDetails (MediaWikiSite $site, array $specialGroups, string $languageCode)
	getSpecialSiteLanguageName (Site $site, string $languageCode)
	shouldSiteBeIncluded (Site $site, array $groups)
	Whether it's needed to add a Site to the JS variable.

Private Attributes
	$clientSettings
	$repoSettings
	$siteLookup
	$cache

Detailed Description

Copyright

GPL-2.0-or-later

Author

Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Daniel Werner < danie.nosp@m.l.a..nosp@m.r.wer.nosp@m.ner@.nosp@m.gmail.nosp@m..com >

Marius Hoch < hoo@o.nosp@m.nlin.nosp@m.e.de >

Constructor & Destructor Documentation

__construct()

Wikibase\Lib\Modules\SitesModule::__construct	(	?SettingsArray	$clientSettings,
		?SettingsArray	$repoSettings,
		SiteLookup	$siteLookup,
		BagOStuff	$cache
	)

Parameters

SettingsArray | null	$clientSettings	The Client settings, if Client is enabled, else null.
SettingsArray | null	$repoSettings	The Repo settings, if Repo is enabled, else null.
SiteLookup	$siteLookup
BagOStuff	$cache

Member Function Documentation

computeSiteDetails()

Wikibase\Lib\Modules\SitesModule::computeSiteDetails ( MediaWikiSite  $site, array  $specialGroups, string  $languageCode  )

private

Parameters

MediaWikiSite	$site
string[]	$specialGroups
string	$languageCode

Returns

string[]

enableModuleContentVersion()

Wikibase\Lib\Modules\SitesModule::enableModuleContentVersion

(

)

getScript()

Wikibase\Lib\Modules\SitesModule::getScript

(

ResourceLoaderContext

$context

)

Used to propagate information about sites to JavaScript.

Sites infos will be available in 'wbSiteDetails' config var.

See also

ResourceLoaderModule::getScript

Parameters

ResourceLoaderContext

$context

Returns

string JavaScript Code

getSetting()

Wikibase\Lib\Modules\SitesModule::getSetting ( string  $settingName )

private

Get a setting from the repo or client settings, with repo overriding client.

getSpecialSiteLanguageName()

Wikibase\Lib\Modules\SitesModule::getSpecialSiteLanguageName ( Site  $site, string  $languageCode  )

private

Parameters

Site	$site
string	$languageCode

Returns

string

shouldSiteBeIncluded()

Wikibase\Lib\Modules\SitesModule::shouldSiteBeIncluded ( Site  $site, array  $groups  )

private

Whether it's needed to add a Site to the JS variable.

Parameters

Site	$site
string[]	$groups

Returns

bool

Member Data Documentation

$cache

Wikibase\Lib\Modules\SitesModule::$cache

private

$clientSettings

Wikibase\Lib\Modules\SitesModule::$clientSettings

private

$repoSettings

Wikibase\Lib\Modules\SitesModule::$repoSettings

private

$siteLookup

Wikibase\Lib\Modules\SitesModule::$siteLookup

private

SITE_DETAILS_TTL

const Wikibase\Lib\Modules\SitesModule::SITE_DETAILS_TTL = 3600

How many seconds the result of getSiteDetails() is cached.

---

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

• lib/includes/Modules/SitesModule.php