ConfigFactory Class Reference

Factory class to create Config objects. More...

Public Member Functions
	makeConfig ($name)
	Create a given Config using the registered callback for $name. More...
	register ($name, $callback)
	Register a new config factory function Will override if it's already registered. More...

Static Public Member Functions
static	getDefaultInstance ()

Protected Attributes
array	$configs = []
	Config objects that have already been created name => Config object. More...
array	$factoryFunctions = []
	Map of config name => callback. More...

Detailed Description

Factory class to create Config objects.

Since

1.23

Definition at line 29 of file ConfigFactory.php.

Member Function Documentation

static ConfigFactory::getDefaultInstance ( )

static

Deprecated:

since 1.27, use MediaWikiServices::getConfigFactory() instead.

Returns

ConfigFactory

Definition at line 49 of file ConfigFactory.php.

Referenced by QuickTemplate\__construct(), PageArchive\__construct(), WikiImporter\__construct(), MediaWiki\Auth\Throttler\__construct(), AjaxResponse\__construct(), MediaWiki\Session\SessionManager\__construct(), MimeMagic\__construct(), ResourceLoader\__construct(), ImportLinkCacheIntegrationTest\doImport(), CleanupRemovedModules\execute(), ImportTextFiles\execute(), RequestContext\getConfig(), ResourceLoaderModule\getConfig(), Maintenance\getConfig(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), SpecialUpload\getInitialPageText(), SpecialEmailUser\getPermissionsError(), MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\getProvider(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\getProvider(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\getProvider(), TemplateParser\getTemplate(), ResourceLoaderContext\newDummyContext(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), CheckStorage\restoreText(), MediaWiki\Auth\AuthManager\singleton(), MimeMagic\singleton(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testCheckPasswordValidity(), MaintenanceTest\testGetConfig(), ConfigFactoryTest\testGetDefaultInstance(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPassword(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPasswordFactory(), ImportTest\testHandlePageContainsRedirect(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag(), ImportTest\testSiteInfoContainsNamespaces(), and ImportTest\testUnknownXMLTags().

ConfigFactory::makeConfig

(

$name

)

Create a given Config using the registered callback for $name.

If an object was already created, the same Config object is returned.

Parameters

string

$name

Name of the extension/component you want a Config object for 'main' is used for core

Exceptions

ConfigException	If a factory function isn't registered for $name
UnexpectedValueException	If the factory function returns a non-Config object

Returns

Config

Definition at line 76 of file ConfigFactory.php.

References $name.

ConfigFactory::register	(		$name,
			$callback
	)

Register a new config factory function Will override if it's already registered.

Parameters

string	$name
callable	$callback	That takes this ConfigFactory as an argument

Exceptions

InvalidArgumentException

If an invalid callback is provided

Definition at line 60 of file ConfigFactory.php.

References $name.

Member Data Documentation

array ConfigFactory::$configs = []

protected

Config objects that have already been created name => Config object.

Definition at line 42 of file ConfigFactory.php.

array ConfigFactory::$factoryFunctions = []

protected

Map of config name => callback.

Definition at line 35 of file ConfigFactory.php.

---

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

• includes/config/ConfigFactory.php