MediaWikiServices is the service locator for the application scope of MediaWiki. More...
Static Public Member Functions | |
| static | disableStorageBackend () |
| Disables all storage layer services. More... | |
| static | failIfResetNotAllowed ( $method) |
| Convenience method that throws an exception unless it is called during a phase in which resetting of global services is allowed. More... | |
| static | forceGlobalInstance (MediaWikiServices $services) |
| Replaces the global MediaWikiServices instance. More... | |
| static | getInstance () |
| Returns the global default instance of the top level service locator. More... | |
| static | hasInstance () |
| Returns true if an instance has already been initialized. More... | |
| static | resetChildProcessServices () |
| Resets any services that may have become stale after a child process returns from after pcntl_fork(). More... | |
| static | resetGlobalInstance (Config $bootstrapConfig=null, $quick='') |
| Creates a new instance of MediaWikiServices and sets it as the global default instance. More... | |
Private Member Functions | |
| salvage (self $other) | |
| @noinspection PhpDocSignatureInspection More... | |
Static Private Member Functions | |
| static | newInstance (Config $bootstrapConfig, $loadWiring='') |
| Creates a new MediaWikiServices instance and initializes it according to the given $bootstrapConfig. More... | |
Static Private Attributes | |
| static MediaWikiServices null | $instance = null |
Additional Inherited Members | |
 Protected Member Functions inherited from Wikimedia\Services\ServiceContainer | |
| resetService (string $name, $destroy=true) | |
| Resets a service by dropping the service instance. More... | |
Detailed Description
MediaWikiServices is the service locator for the application scope of MediaWiki.
Its implemented as a simple configurable DI container. MediaWikiServices acts as a top level factory/registry for top level services, and builds the network of service objects that defines MediaWiki's application logic. It acts as an entry point to MediaWiki's dependency injection mechanism.
Services are defined in the "wiring" array passed to the constructor, or by calling defineService().
- See also
- docs/Injection.md for an overview of using dependency injection in the MediaWiki code base.
Definition at line 130 of file MediaWikiServices.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\MediaWikiServices::__construct | ( | Config | $config | ) |
- Parameters
-
Config $config The Config object to be registered as the 'BootstrapConfig' service. This has to contain at least the information needed to set up the 'ConfigFactory' service.
Definition at line 442 of file MediaWikiServices.php.
Member Function Documentation
◆ disableStorageBackend()
|
static |
Disables all storage layer services.
After calling this, any attempt to access the storage layer will result in an error. Use resetGlobalInstance() to restore normal operation.
- Since
- 1.28
- Warning
- This is intended for extreme situations only and should never be used while serving normal web requests. Legitimate use cases for this method include the installation process. Test fixtures may also use this, if the fixture relies on globalState.
Definition at line 336 of file MediaWikiServices.php.
References ObjectCache\clear().
◆ failIfResetNotAllowed()
|
static |
Convenience method that throws an exception unless it is called during a phase in which resetting of global services is allowed.
In general, services should not be reset individually, since that may introduce inconsistencies.
- Since
- 1.28
This method will throw an exception if:
- self::$resetInProgress is false (to allow all services to be reset together via resetGlobalInstance)
- and MEDIAWIKI_INSTALL is not defined (to allow services to be reset during installation)
- and MW_PHPUNIT_TEST is not defined (to allow services to be reset during testing)
This method is intended to be used to safeguard against accidentally resetting global service instances that are not yet managed by MediaWikiServices. It is defined here in the MediaWikiServices services class to have a central place for managing service bootstrapping and resetting.
- Parameters
-
string $method the name of the caller method, as given by METHOD.
- Exceptions
-
MWException if called outside bootstrap mode.
Definition at line 426 of file MediaWikiServices.php.
◆ forceGlobalInstance()
|
static |
Replaces the global MediaWikiServices instance.
- Since
- 1.28
- Note
- This is for use in PHPUnit tests only!
- Exceptions
-
MWException if called outside of PHPUnit tests.
- Parameters
-
MediaWikiServices $services The new MediaWikiServices object.
- Returns
- MediaWikiServices The old MediaWikiServices object, so it can be restored later.
Definition at line 187 of file MediaWikiServices.php.
◆ getActorMigration()
| MediaWiki\MediaWikiServices::getActorMigration | ( | ) |
◆ getBadFileLookup()
| MediaWiki\MediaWikiServices::getBadFileLookup | ( | ) |
◆ getBlobStore()
| MediaWiki\MediaWikiServices::getBlobStore | ( | ) |
◆ getBlobStoreFactory()
| MediaWiki\MediaWikiServices::getBlobStoreFactory | ( | ) |
◆ getBlockErrorFormatter()
| MediaWiki\MediaWikiServices::getBlockErrorFormatter | ( | ) |
◆ getBlockManager()
| MediaWiki\MediaWikiServices::getBlockManager | ( | ) |
◆ getBlockRestrictionStore()
| MediaWiki\MediaWikiServices::getBlockRestrictionStore | ( | ) |
◆ getBootstrapConfig()
| MediaWiki\MediaWikiServices::getBootstrapConfig | ( | ) |
Returns the Config object containing the bootstrap configuration.
Bootstrap configuration would typically include database credentials and other information that may be needed before the ConfigFactory service can be instantiated.
- Note
- This should only be used during bootstrapping, in particular when creating the MainConfig service. Application logic should use getMainConfig() to get a Config instances.
- Since
- 1.27
- Returns
- Config
Definition at line 522 of file MediaWikiServices.php.
◆ getChangeTagDefStore()
| MediaWiki\MediaWikiServices::getChangeTagDefStore | ( | ) |
◆ getCommentStore()
| MediaWiki\MediaWikiServices::getCommentStore | ( | ) |
◆ getConfigFactory()
| MediaWiki\MediaWikiServices::getConfigFactory | ( | ) |
◆ getConfigRepository()
| MediaWiki\MediaWikiServices::getConfigRepository | ( | ) |
◆ getConfiguredReadOnlyMode()
| MediaWiki\MediaWikiServices::getConfiguredReadOnlyMode | ( | ) |
◆ getContentLanguage()
| MediaWiki\MediaWikiServices::getContentLanguage | ( | ) |
◆ getContentModelStore()
| MediaWiki\MediaWikiServices::getContentModelStore | ( | ) |
◆ getCryptHKDF()
| MediaWiki\MediaWikiServices::getCryptHKDF | ( | ) |
◆ getDateFormatterFactory()
| MediaWiki\MediaWikiServices::getDateFormatterFactory | ( | ) |
◆ getDBLoadBalancer()
| MediaWiki\MediaWikiServices::getDBLoadBalancer | ( | ) |
- Since
- 1.28
- Returns
- ILoadBalancer The main DB load balancer for the local wiki.
Definition at line 602 of file MediaWikiServices.php.
◆ getDBLoadBalancerFactory()
| MediaWiki\MediaWikiServices::getDBLoadBalancerFactory | ( | ) |
◆ getEventRelayerGroup()
| MediaWiki\MediaWikiServices::getEventRelayerGroup | ( | ) |
◆ getExternalStoreAccess()
| MediaWiki\MediaWikiServices::getExternalStoreAccess | ( | ) |
◆ getExternalStoreFactory()
| MediaWiki\MediaWikiServices::getExternalStoreFactory | ( | ) |
◆ getFileBackendGroup()
| MediaWiki\MediaWikiServices::getFileBackendGroup | ( | ) |
◆ getGenderCache()
| MediaWiki\MediaWikiServices::getGenderCache | ( | ) |
◆ getHttpRequestFactory()
| MediaWiki\MediaWikiServices::getHttpRequestFactory | ( | ) |
◆ getInstance()
|
static |
Returns the global default instance of the top level service locator.
- Since
- 1.27
The default instance is initialized using the service instantiator functions defined in ServiceWiring.php.
- Note
- This should only be called by static functions! The instance returned here should not be passed around! Objects that need access to a service should have that service injected into the constructor, never a service locator!
- Returns
- MediaWikiServices
Definition at line 161 of file MediaWikiServices.php.
Referenced by MediaWiki\Auth\Throttler\__construct(), MediaWiki\Session\SessionManager\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), File\checkExtensionCompatibility(), MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature(), MediaWiki\Block\DatabaseBlock\clearCookie(), MediaWiki\Shell\Shell\command(), StreamFile\contentTypeFromPath(), DeleteAutoPatrolLogs\deleteRows(), PopulateChangeTagDef\doDBUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), SpecialNewFiles\execute(), RunBatchedQuery\execute(), ImageBuilder\execute(), RebuildFileCache\finalSetup(), MediaWiki\Widget\Search\FullSearchResultWidget\generateFileHtml(), ApiQuerySearch\getAllowedParams(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), MediaWiki\Block\DatabaseBlock\getBlockRestrictionStore(), MediaWiki\Block\DatabaseBlock\getBlocksForIPList(), MediaWiki\Block\DatabaseBlock\getCookieValue(), UploadStash\getExtensionForPath(), SpecialMediaStatistics\getExtensionList(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), MediaWiki\Block\DatabaseBlock\getIdFromCookieValue(), MediaWiki\Languages\LanguageFactory\getLanguage(), ForeignAPIFile\getMediaType(), UnregisteredLocalFile\getMimeType(), ForeignAPIFile\getMimeType(), MediaWiki\Block\AbstractBlock\getPermissionsError(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), MediaWiki\EditPage\TextboxBuilder\getTextboxProtectionCSSClasses(), MediaHandler\getThumbType(), DjVuHandler\getThumbType(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), MediaWiki\Rest\EntryPoint\main(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\parseTitle(), MediaWiki\performRequest(), MediaWiki\Widget\Search\SearchFormWidget\powerSearchBox(), MediaWiki\preOutputCommit(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), MediaWiki\Block\AbstractBlock\prevents(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Block\DatabaseBlock\purgeExpired(), MediaWiki\Widget\Search\FullSearchResultWidget\render(), MediaWiki\Widget\Search\BasicSearchResultSetWidget\render(), MediaWiki\restInPeace(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), MediaWiki\Block\DatabaseBlock\setCookie(), MediaWiki\setDBProfilingAgent(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Widget\Search\SearchFormWidget\startsWithImage(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\testUserForCreation(), MediaWiki\triggerAsyncJobs(), MediaWiki\tryNormaliseRedirect(), Revision\RevisionRecord\userCanBitfield(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().
◆ getInterwikiLookup()
| MediaWiki\MediaWikiServices::getInterwikiLookup | ( | ) |
◆ getLanguageFactory()
| MediaWiki\MediaWikiServices::getLanguageFactory | ( | ) |
◆ getLanguageFallback()
| MediaWiki\MediaWikiServices::getLanguageFallback | ( | ) |
◆ getLanguageNameUtils()
| MediaWiki\MediaWikiServices::getLanguageNameUtils | ( | ) |
◆ getLinkBatchFactory()
| MediaWiki\MediaWikiServices::getLinkBatchFactory | ( | ) |
◆ getLinkCache()
| MediaWiki\MediaWikiServices::getLinkCache | ( | ) |
◆ getLinkRenderer()
| MediaWiki\MediaWikiServices::getLinkRenderer | ( | ) |
LinkRenderer instance that can be used if no custom options are needed.
- Since
- 1.28
- Returns
- LinkRenderer
Definition at line 717 of file MediaWikiServices.php.
◆ getLinkRendererFactory()
| MediaWiki\MediaWikiServices::getLinkRendererFactory | ( | ) |
◆ getLocalisationCache()
| MediaWiki\MediaWikiServices::getLocalisationCache | ( | ) |
◆ getLocalServerObjectCache()
| MediaWiki\MediaWikiServices::getLocalServerObjectCache | ( | ) |
◆ getLockManagerGroupFactory()
| MediaWiki\MediaWikiServices::getLockManagerGroupFactory | ( | ) |
◆ getMagicWordFactory()
| MediaWiki\MediaWikiServices::getMagicWordFactory | ( | ) |
◆ getMainConfig()
| MediaWiki\MediaWikiServices::getMainConfig | ( | ) |
Returns the Config object that provides configuration for MediaWiki core.
This may or may not be the same object that is returned by getBootstrapConfig().
- Since
- 1.27
- Returns
- Config
Definition at line 768 of file MediaWikiServices.php.
Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().
◆ getMainObjectStash()
| MediaWiki\MediaWikiServices::getMainObjectStash | ( | ) |
◆ getMainWANObjectCache()
| MediaWiki\MediaWikiServices::getMainWANObjectCache | ( | ) |
◆ getMediaHandlerFactory()
| MediaWiki\MediaWikiServices::getMediaHandlerFactory | ( | ) |
◆ getMessageCache()
| MediaWiki\MediaWikiServices::getMessageCache | ( | ) |
◆ getMessageFormatterFactory()
| MediaWiki\MediaWikiServices::getMessageFormatterFactory | ( | ) |
- Since
- 1.34
- Returns
- IMessageFormatterFactory
Definition at line 808 of file MediaWikiServices.php.
Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().
◆ getMimeAnalyzer()
| MediaWiki\MediaWikiServices::getMimeAnalyzer | ( | ) |
◆ getMovePageFactory()
| MediaWiki\MediaWikiServices::getMovePageFactory | ( | ) |
◆ getNamespaceInfo()
| MediaWiki\MediaWikiServices::getNamespaceInfo | ( | ) |
◆ getNameTableStoreFactory()
| MediaWiki\MediaWikiServices::getNameTableStoreFactory | ( | ) |
◆ getObjectFactory()
| MediaWiki\MediaWikiServices::getObjectFactory | ( | ) |
ObjectFactory is intended for instantiating "handlers" from declarative definitions, such as Action API modules, special pages, or REST API handlers.
- Since
- 1.34
- Returns
- ObjectFactory
Definition at line 851 of file MediaWikiServices.php.
◆ getOldRevisionImporter()
| MediaWiki\MediaWikiServices::getOldRevisionImporter | ( | ) |
◆ getPageEditStash()
| MediaWiki\MediaWikiServices::getPageEditStash | ( | ) |
◆ getParser()
| MediaWiki\MediaWikiServices::getParser | ( | ) |
◆ getParserCache()
| MediaWiki\MediaWikiServices::getParserCache | ( | ) |
◆ getParserFactory()
| MediaWiki\MediaWikiServices::getParserFactory | ( | ) |
◆ getPasswordFactory()
| MediaWiki\MediaWikiServices::getPasswordFactory | ( | ) |
◆ getPasswordReset()
| MediaWiki\MediaWikiServices::getPasswordReset | ( | ) |
◆ getPerDbNameStatsdDataFactory()
| MediaWiki\MediaWikiServices::getPerDbNameStatsdDataFactory | ( | ) |
◆ getPermissionManager()
| MediaWiki\MediaWikiServices::getPermissionManager | ( | ) |
◆ getPreferencesFactory()
| MediaWiki\MediaWikiServices::getPreferencesFactory | ( | ) |
◆ getProxyLookup()
| MediaWiki\MediaWikiServices::getProxyLookup | ( | ) |
◆ getReadOnlyMode()
| MediaWiki\MediaWikiServices::getReadOnlyMode | ( | ) |
◆ getRepoGroup()
| MediaWiki\MediaWikiServices::getRepoGroup | ( | ) |
◆ getResourceLoader()
| MediaWiki\MediaWikiServices::getResourceLoader | ( | ) |
◆ getRevisionFactory()
| MediaWiki\MediaWikiServices::getRevisionFactory | ( | ) |
◆ getRevisionLookup()
| MediaWiki\MediaWikiServices::getRevisionLookup | ( | ) |
◆ getRevisionRenderer()
| MediaWiki\MediaWikiServices::getRevisionRenderer | ( | ) |
◆ getRevisionStore()
| MediaWiki\MediaWikiServices::getRevisionStore | ( | ) |
◆ getRevisionStoreFactory()
| MediaWiki\MediaWikiServices::getRevisionStoreFactory | ( | ) |
◆ getSearchEngineConfig()
| MediaWiki\MediaWikiServices::getSearchEngineConfig | ( | ) |
◆ getSearchEngineFactory()
| MediaWiki\MediaWikiServices::getSearchEngineFactory | ( | ) |
◆ getShellCommandFactory()
| MediaWiki\MediaWikiServices::getShellCommandFactory | ( | ) |
◆ getSiteLookup()
| MediaWiki\MediaWikiServices::getSiteLookup | ( | ) |
◆ getSiteStore()
| MediaWiki\MediaWikiServices::getSiteStore | ( | ) |
◆ getSkinFactory()
| MediaWiki\MediaWikiServices::getSkinFactory | ( | ) |
◆ getSlotRoleRegistry()
| MediaWiki\MediaWikiServices::getSlotRoleRegistry | ( | ) |
◆ getSlotRoleStore()
| MediaWiki\MediaWikiServices::getSlotRoleStore | ( | ) |
◆ getSpecialPageFactory()
| MediaWiki\MediaWikiServices::getSpecialPageFactory | ( | ) |
◆ getStatsdDataFactory()
| MediaWiki\MediaWikiServices::getStatsdDataFactory | ( | ) |
◆ getTempFSFileFactory()
| MediaWiki\MediaWikiServices::getTempFSFileFactory | ( | ) |
◆ getTitleFactory()
| MediaWiki\MediaWikiServices::getTitleFactory | ( | ) |
◆ getTitleFormatter()
| MediaWiki\MediaWikiServices::getTitleFormatter | ( | ) |
◆ getTitleParser()
| MediaWiki\MediaWikiServices::getTitleParser | ( | ) |
◆ getUploadRevisionImporter()
| MediaWiki\MediaWikiServices::getUploadRevisionImporter | ( | ) |
◆ getVirtualRESTServiceClient()
| MediaWiki\MediaWikiServices::getVirtualRESTServiceClient | ( | ) |
◆ getWatchedItemQueryService()
| MediaWiki\MediaWikiServices::getWatchedItemQueryService | ( | ) |
◆ getWatchedItemStore()
| MediaWiki\MediaWikiServices::getWatchedItemStore | ( | ) |
◆ getWikiRevisionOldRevisionImporter()
| MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporter | ( | ) |
◆ getWikiRevisionOldRevisionImporterNoUpdates()
| MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporterNoUpdates | ( | ) |
◆ getWikiRevisionUploadImporter()
| MediaWiki\MediaWikiServices::getWikiRevisionUploadImporter | ( | ) |
◆ hasInstance()
|
static |
Returns true if an instance has already been initialized.
This can be used to avoid accessing services if it's not safe, such as in unit tests or early setup.
- Returns
- bool
Definition at line 143 of file MediaWikiServices.php.
Referenced by MediaWiki\Languages\LanguageFactory\getLanguage().
◆ newInstance()
|
staticprivate |
Creates a new MediaWikiServices instance and initializes it according to the given $bootstrapConfig.
In particular, all wiring files defined in the ServiceWiringFiles setting are loaded, and the MediaWikiServices hook is called.
- Parameters
-
Config | null $bootstrapConfig The Config object to be registered as the 'BootstrapConfig' service. string $loadWiring set this to 'load' to load the wiring files specified in the 'ServiceWiringFiles' setting in $bootstrapConfig.
- Returns
- MediaWikiServices
- Exceptions
-
MWException
Definition at line 306 of file MediaWikiServices.php.
References Config\get(), and Hooks\run().
◆ newSearchEngine()
| MediaWiki\MediaWikiServices::newSearchEngine | ( | ) |
◆ resetChildProcessServices()
|
static |
Resets any services that may have become stale after a child process returns from after pcntl_fork().
It's also safe, but generally unnecessary, to call this method from the parent process.
- Since
- 1.28
- Note
- This is intended for use in the context of process forking only!
Definition at line 360 of file MediaWikiServices.php.
◆ resetGlobalInstance()
|
static |
Creates a new instance of MediaWikiServices and sets it as the global default instance.
getInstance() will return a different MediaWikiServices object after every call to resetGlobalInstance().
- Since
- 1.28
- Warning
- This should not be used during normal operation. It is intended for use when the configuration has changed significantly since bootstrap time, e.g. during the installation process or during testing.
- Calling resetGlobalInstance() may leave the application in an inconsistent state. Calling this is only safe under the ASSUMPTION that NO REFERENCE to any of the services managed by MediaWikiServices exist. If any service objects managed by the old MediaWikiServices instance remain in use, they may INTERFERE with the operation of the services managed by the new MediaWikiServices. Operating with a mix of services created by the old and the new MediaWikiServices instance may lead to INCONSISTENCIES and even DATA LOSS! Any class implementing LAZY LOADING is especially prone to this problem, since instances would typically retain a reference to a storage layer service.
- See also
- forceGlobalInstance()
- resetGlobalInstance()
- resetBetweenTest()
- Parameters
-
Config | null $bootstrapConfig The Config object to be registered as the 'BootstrapConfig' service. This has to contain at least the information needed to set up the 'ConfigFactory' service. If not given, the bootstrap config of the old instance of MediaWikiServices will be re-used. If there was no previous instance, a new GlobalVarConfig object will be used to bootstrap the services. string $quick Set this to "quick" to allow expensive resources to be re-used. See SalvageableService for details.
- Exceptions
-
MWException If called after MW_SERVICE_BOOTSTRAP_COMPLETE has been defined in Setup.php (unless MW_PHPUNIT_TEST or MEDIAWIKI_INSTALL or RUN_MAINTENANCE_IF_MAIN is defined).
Definition at line 237 of file MediaWikiServices.php.
◆ resetServiceForTesting()
| MediaWiki\MediaWikiServices::resetServiceForTesting | ( | $name, | |
$destroy = true |
|||
| ) |
Resets the given service for testing purposes.
- Since
- 1.28
- Warning
- This is generally unsafe! Other services may still retain references to the stale service instance, leading to failures and inconsistencies. Subclasses may use this method to reset specific services under specific instances, but it should not be exposed to application logic.
- Note
- With proper dependency injection used throughout the codebase, this method should not be needed. It is provided to allow tests that pollute global service instances to clean up.
- Parameters
-
string $name bool $destroy Whether the service instance should be destroyed if it exists. When set to false, any existing service instance will effectively be detached from the container.
- Exceptions
-
MWException if called outside of PHPUnit tests.
Definition at line 391 of file MediaWikiServices.php.
◆ salvage()
|
private |
@noinspection PhpDocSignatureInspection
Salvages the state of any salvageable service instances in $other.
- Note
- $other will have been destroyed when salvage() returns.
- Parameters
-
MediaWikiServices $other
Definition at line 270 of file MediaWikiServices.php.
Member Data Documentation
◆ $instance
|
staticprivate |
Definition at line 135 of file MediaWikiServices.php.
The documentation for this class was generated from the following file:
- includes/MediaWikiServices.php
