MediaWiki  master
Public Member Functions | List of all members
Config Interface Reference

Interface for configuration instances. More...

Inheritance diagram for Config:
Inheritance graph
[legend]

Public Member Functions

 get ( $name)
 Get a configuration variable such as "Sitename" or "UploadMaintenance.". More...
 
 has ( $name)
 Check whether a configuration option is set for the given name. More...
 

Detailed Description

Interface for configuration instances.

Stability: stable
to implement
Since
1.23

Definition at line 30 of file Config.php.

Member Function Documentation

◆ get()

Config::get (   $name)

Get a configuration variable such as "Sitename" or "UploadMaintenance.".

Parameters
string$nameName of configuration option
Returns
mixed Value configured
Exceptions
ConfigException

Implemented in MultiConfig, HashConfig, GlobalVarConfig, and EtcdConfig.

Referenced by MediaWiki\Auth\Throttler\__construct(), LocalIdLookup\__construct(), ResourceLoader\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Block\DatabaseBlock\appliesToRight(), MediaWiki\Block\AbstractBlock\appliesToUsertalk(), MWLBFactory\applyGlobalState(), MediaWiki\Http\HttpRequestFactory\createGuzzleClient(), PopulateImageSha1\doDBUpdates(), MediaWiki\emitBufferedStatsdData(), MultiConfig\get(), ApiQueryUserInfo\getCentralUserInfo(), SpecialVersion\getCredits(), QueryPage\getDisabledQueryPages(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), Installer\getInstallerConfig(), ApiUpload\getMinUploadChunkSize(), ResourceLoaderUserModule\getPages(), ResourceLoaderUserStylesModule\getPages(), ResourceLoaderWikiModule\getPages(), Pingback\getSystemInfo(), MediaWiki\Config\ConfigRepository\getValueOf(), PasswordFactory\init(), ContentSecurityPolicy\isNonceRequired(), ContentSecurityPolicy\makeCSPDirectives(), MediaWiki\MediaWikiServices\newInstance(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\preOutputCommit(), Pingback\schedulePingback(), and OutputPage\transformResourcePath().

◆ has()

Config::has (   $name)

Check whether a configuration option is set for the given name.

Parameters
string$nameName of configuration option
Returns
bool
Since
1.24

Implemented in MultiConfig, HashConfig, GlobalVarConfig, and EtcdConfig.

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