MediaWiki\Config\Config Interface Reference

Interface for configuration instances. More...

Inherited by MediaWiki\Config\EtcdConfig, MediaWiki\Config\GlobalVarConfig, MediaWiki\Config\HashConfig, MediaWiki\Config\IterableConfig, and MediaWiki\Config\MultiConfig.

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

Detailed Description

Interface for configuration instances.

Stability: stable

to implement

Since

1.23

Definition at line 32 of file Config.php.

Member Function Documentation

get()

MediaWiki\Config\Config::get

(

$name

)

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

Parameters

string

$name

Name of configuration option

Returns

mixed Value configured

Exceptions

ConfigException

Implemented in MediaWiki\Config\EtcdConfig, MediaWiki\Config\GlobalVarConfig, MediaWiki\Config\HashConfig, and MediaWiki\Config\MultiConfig.

Referenced by MediaWiki\EditPage\EditPage\__construct(), McrUndoAction\__construct(), MediaWiki\User\CentralId\LocalIdLookup\__construct(), MediaWiki\Rest\Handler\SearchHandler\__construct(), MediaWiki\Rest\Handler\OpenSearchDescriptionHandler\__construct(), MediaWiki\RenameUser\RenameUserJob\__construct(), MediaWiki\MediaWikiEntryPoint\commitMainTransaction(), MediaWiki\MediaWikiEntryPoint\emitBufferedStatsdData(), MediaWiki\Api\ApiQueryUserInfo\getCentralUserInfo(), MediaWiki\Skin\SkinComponentCopyright\getCopyrightHTML(), MediaWiki\SpecialPage\QueryPage\getDisabledQueryPages(), MediaWiki\Skin\SkinComponentFooter\getFooterIconsData(), MediaWiki\Installer\Installer\getInstallerConfig(), MediaWiki\Api\ApiUpload\getMinUploadChunkSize(), MediaWiki\ResourceLoader\UserModule\getPages(), MediaWiki\ResourceLoader\UserStylesModule\getPages(), MediaWiki\ResourceLoader\WikiModule\getPages(), MediaWiki\ResourceLoader\FileModule\getScriptURLsForDebug(), MediaWiki\Request\ContentSecurityPolicy\isNonceRequired(), MediaWiki\Request\FauxResponse\setCookie(), MediaWiki\Output\OutputPage\transformResourcePath(), and MediaWiki\Settings\Config\ConfigSchemaAggregator\validateConfig().

has()

MediaWiki\Config\Config::has

(

$name

)

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

Parameters

string

$name

Name of configuration option

Returns

bool

Since

1.24

Implemented in MediaWiki\Config\EtcdConfig, MediaWiki\Config\GlobalVarConfig, MediaWiki\Config\HashConfig, and MediaWiki\Config\MultiConfig.

Referenced by MediaWiki\Settings\Config\ConfigSchemaAggregator\validateConfig().

---

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

• includes/config/Config.php