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, LanguageNameLookupFactory $languageNameLookupFactory)
	getScript (RL\Context $context)
	Used to propagate information about sites to JavaScript.
Public Member Functions inherited from Wikibase\Lib\Modules\SitesModuleBase
	__construct (?SettingsArray $clientSettings, ?SettingsArray $repoSettings, LanguageNameLookupFactory $languageNameLookupFactory)
	enableModuleContentVersion ()
	getSetting (string $settingName)
	Get a setting from the repo or client settings, with repo overriding client.
	computeSiteDetails (MediaWikiSite $site, array $specialGroups, MessageLocalizer $localizer)

Private Member Functions
	shouldSiteBeIncluded (Site $site, array $groups)
	Whether it's needed to add a Site to the JS variable.

Private Attributes
const	SITE_DETAILS_TTL = 3600
	How many seconds the result of getSiteDetails() is cached.
	$siteLookup
	$cache

Additional Inherited Members
Protected Member Functions inherited from Wikibase\Lib\Modules\SitesModuleBase
	makeScript (MessageLocalizer $localizer)

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 >

Guergana Tzatchkova < pesta.nosp@m.nias.nosp@m.@yaho.nosp@m.o.co.nosp@m.m >

Constructor & Destructor Documentation

__construct()

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

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
LanguageNameLookupFactory	$languageNameLookupFactory

Member Function Documentation

getScript()

Wikibase\Lib\Modules\SitesModule::getScript

(

RL\Context

$context

)

Used to propagate information about sites to JavaScript.

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

See also

RL\Module::getScript

Parameters

RL\Context

$context

Returns

string JavaScript Code

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

$siteLookup

Wikibase\Lib\Modules\SitesModule::$siteLookup

private

SITE_DETAILS_TTL

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

private

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