Factory class to create Config objects. More...
Public Member Functions | |
| getConfigNames () | |
| makeConfig ( $name) | |
| Create a given Config using the registered callback for $name. | |
| register ( $name, $callback) | |
| Register a new config factory function. | |
| salvage (SalvageableService $other) | |
| Re-uses existing Cache objects from $other. | |
Static Public Member Functions | |
| static | getDefaultInstance () |
Protected Attributes | |
| array | $configs = [] |
| Config objects that have already been created name => Config object. | |
| array | $factoryFunctions = [] |
| Map of config name => callback. | |
Detailed Description
Member Function Documentation
◆ getConfigNames()
| ConfigFactory::getConfigNames | ( | ) |
- Returns
- string[]
Definition at line 93 of file ConfigFactory.php.
Referenced by MediaWikiTestCase\makeTestConfigFactoryInstantiator().
◆ getDefaultInstance()
|
static |
- Deprecated:
- since 1.27, use MediaWikiServices::getConfigFactory() instead.
- Returns
- ConfigFactory
Definition at line 51 of file ConfigFactory.php.
Referenced by MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\getProvider(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\getProvider(), MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\getProvider(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testCheckPasswordValidity(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPassword(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPasswordFactory(), and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag().
◆ makeConfig()
| 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 124 of file ConfigFactory.php.
References $name.
Referenced by MediaWikiTestCase\makeTestConfigFactoryInstantiator().
◆ register()
| ConfigFactory::register | ( | $name, | |
| $callback | |||
| ) |
Register a new config factory function.
Will override if it's already registered. Use "*" for $name to provide a fallback config for all unknown names.
- Parameters
-
string $name callable | Config $callback A factory callabck that takes this ConfigFactory as an argument and returns a Config instance, or an existing Config instance.
- Exceptions
-
InvalidArgumentException If an invalid callback is provided
Definition at line 106 of file ConfigFactory.php.
References $name.
◆ salvage()
| ConfigFactory::salvage | ( | SalvageableService | $other | ) |
Re-uses existing Cache objects from $other.
Cache objects are only re-used if the registered factory function for both is the same. Cache config is not copied, and only instances of caches defined on this instance with the same config are copied.
- See also
- SalvageableService::salvage()
- Parameters
-
SalvageableService $other The object to salvage state from. $other must have the exact same type as $this.
Implements MediaWiki\Services\SalvageableService.
Definition at line 66 of file ConfigFactory.php.
Member Data Documentation
◆ $configs
|
protected |
Config objects that have already been created name => Config object.
Definition at line 44 of file ConfigFactory.php.
◆ $factoryFunctions
|
protected |
Map of config name => callback.
Definition at line 37 of file ConfigFactory.php.
The documentation for this class was generated from the following file:
- includes/config/ConfigFactory.php
