Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Lib\Modules\SitesModuleBase Class Reference
+ Inheritance diagram for Wikibase\Lib\Modules\SitesModuleBase:
+ Collaboration diagram for Wikibase\Lib\Modules\SitesModuleBase:

Public Member Functions

 __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)
 

Protected Member Functions

 makeScript (MessageLocalizer $localizer)
 

Private Member Functions

 getSpecialSiteLanguageName (Site $site, MessageLocalizer $localizer)
 

Private Attributes

 $clientSettings
 
 $repoSettings
 
 $languageNameLookupFactory
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Lib\Modules\SitesModuleBase::__construct ( ?SettingsArray  $clientSettings,
?SettingsArray  $repoSettings,
LanguageNameLookupFactory  $languageNameLookupFactory 
)
Parameters
SettingsArray | null$clientSettingsThe Client settings, if Client is enabled, else null.
SettingsArray | null$repoSettingsThe Repo settings, if Repo is enabled, else null.
LanguageNameLookupFactory$languageNameLookupFactory

Member Function Documentation

◆ computeSiteDetails()

Wikibase\Lib\Modules\SitesModuleBase::computeSiteDetails ( MediaWikiSite  $site,
array  $specialGroups,
MessageLocalizer  $localizer 
)
Parameters
MediaWikiSite$site
string[]$specialGroups
MessageLocalizer$localizer
Returns
array

◆ enableModuleContentVersion()

Wikibase\Lib\Modules\SitesModuleBase::enableModuleContentVersion ( )

◆ getSetting()

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

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

Returns
mixed

◆ getSpecialSiteLanguageName()

Wikibase\Lib\Modules\SitesModuleBase::getSpecialSiteLanguageName ( Site  $site,
MessageLocalizer  $localizer 
)
private
Parameters
Site$site
MessageLocalizer$localizer
Returns
string

◆ makeScript()

Wikibase\Lib\Modules\SitesModuleBase::makeScript ( MessageLocalizer  $localizer)
abstractprotected
Parameters
MessageLocalizer$localizer
Returns
string JavaScript Code

Reimplemented in Wikibase\Lib\Modules\CurrentSiteModule.

Member Data Documentation

◆ $clientSettings

Wikibase\Lib\Modules\SitesModuleBase::$clientSettings
private

◆ $languageNameLookupFactory

Wikibase\Lib\Modules\SitesModuleBase::$languageNameLookupFactory
private

◆ $repoSettings

Wikibase\Lib\Modules\SitesModuleBase::$repoSettings
private

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