MediaWikiServices is the service locator for the application scope of MediaWiki. More...

Inheritance diagram for MediaWiki\MediaWikiServices:

Collaboration diagram for MediaWiki\MediaWikiServices:

[legend]

Public Member Functions
	__construct (Config $config)

	getBootstrapConfig ()
	Returns the Config object containing the bootstrap configuration. More...

	getConfigFactory ()

	getConfiguredReadOnlyMode ()

	getCryptHKDF ()

	getCryptRand ()

	getDBLoadBalancer ()

	getDBLoadBalancerFactory ()

	getEventRelayerGroup ()

	getGenderCache ()

	getInterwikiLookup ()

	getLinkCache ()

	getLinkRenderer ()
	LinkRenderer instance that can be used if no custom options are needed. More...

	getLinkRendererFactory ()

	getLocalServerObjectCache ()

	getMainConfig ()
	Returns the Config object that provides configuration for MediaWiki core. More...

	getMainObjectStash ()

	getMainWANObjectCache ()

	getMediaHandlerFactory ()

	getMimeAnalyzer ()

	getParser ()

	getParserCache ()

	getProxyLookup ()

	getReadOnlyMode ()

	getSearchEngineConfig ()

	getSearchEngineFactory ()

	getShellCommandFactory ()

	getSiteLookup ()

	getSiteStore ()

	getSkinFactory ()

	getStatsdDataFactory ()

	getTitleFormatter ()

	getTitleParser ()

	getVirtualRESTServiceClient ()

	getWatchedItemQueryService ()

	getWatchedItemStore ()

	newSearchEngine ()

	resetServiceForTesting ( $name, $destroy=true)
	Resets the given service for testing purposes. More...

Public Member Functions inherited from MediaWiki\Services\ServiceContainer
	__construct (array $extraInstantiationParams=[])

	applyWiring (array $serviceInstantiators)
	Registers multiple services (aka a "wiring"). More...

	defineService ( $name, callable $instantiator)
	Define a new service. More...

	destroy ()
	Destroys all contained service instances that implement the DestructibleService interface. More...

	disableService ( $name)
	Disables a service. More...

	getService ( $name)
	Returns a service object of the kind associated with $name. More...

	getServiceNames ()

	hasService ( $name)
	Returns true if a service is defined for $name, that is, if a call to getService( $name ) would return a service instance. More...

	importWiring (ServiceContainer $container, $skip=[])
	Imports all wiring defined in $container. More...

	isServiceDisabled ( $name)

	loadWiringFiles (array $wiringFiles)

	peekService ( $name)
	Returns the service instance for $name only if that service has already been instantiated. More...

	redefineService ( $name, callable $instantiator)
	Replace an already defined service. 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	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)
	Salvages the state of any salvageable service instances in $other. 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 MediaWiki\Services\ServiceContainer
	resetService ( $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.txt for an overview of using dependency injection in the MediaWiki code base.

Definition at line 78 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 378 of file MediaWikiServices.php.

References use.

Member Function Documentation

◆ disableStorageBackend()

static MediaWiki\MediaWikiServices::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.

See also: resetGlobalInstance(); resetChildProcessServices()

Definition at line 272 of file MediaWikiServices.php.

References $name, $services, as, and ObjectCache\clear().

Referenced by Installer\__construct(), ObjectCacheTest\testNewAnythingNoAccelNoDb(), and ObjectCacheTest\testNewAnythingNothingNoDb().

◆ failIfResetNotAllowed()

static MediaWiki\MediaWikiServices::failIfResetNotAllowed ( $method )

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.

See also: resetGlobalInstance(); forceGlobalInstance(); disableStorageBackend()

Definition at line 362 of file MediaWikiServices.php.

◆ forceGlobalInstance()

static MediaWiki\MediaWikiServices::forceGlobalInstance ( MediaWikiServices $services )

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 125 of file MediaWikiServices.php.

References $services.

◆ 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 402 of file MediaWikiServices.php.

Referenced by MediaWikiTestCase\installTestServices().

◆ getConfigFactory()

MediaWiki\MediaWikiServices::getConfigFactory ( )

Since: 1.27

Returns: ConfigFactory

Definition at line 410 of file MediaWikiServices.php.

◆ getConfiguredReadOnlyMode()

MediaWiki\MediaWikiServices::getConfiguredReadOnlyMode ( )

Since: 1.29

Returns: \ConfiguredReadOnlyMode

Definition at line 673 of file MediaWikiServices.php.

◆ getCryptHKDF()

MediaWiki\MediaWikiServices::getCryptHKDF ( )

Since: 1.28

Returns: CryptHKDF

Definition at line 542 of file MediaWikiServices.php.

◆ getCryptRand()

MediaWiki\MediaWikiServices::getCryptRand ( )

Since: 1.28

Returns: CryptRand

Definition at line 534 of file MediaWikiServices.php.

◆ getDBLoadBalancer()

MediaWiki\MediaWikiServices::getDBLoadBalancer ( )

Since: 1.28

Returns: LoadBalancer The main DB load balancer for the local wiki.

Definition at line 510 of file MediaWikiServices.php.

◆ getDBLoadBalancerFactory()

MediaWiki\MediaWikiServices::getDBLoadBalancerFactory ( )

Since: 1.28

Returns: LBFactory

Definition at line 502 of file MediaWikiServices.php.

◆ getEventRelayerGroup()

MediaWiki\MediaWikiServices::getEventRelayerGroup ( )

Since: 1.27

Returns: EventRelayerGroup

Definition at line 461 of file MediaWikiServices.php.

◆ getGenderCache()

MediaWiki\MediaWikiServices::getGenderCache ( )

Since: 1.28

Returns: GenderCache

Definition at line 590 of file MediaWikiServices.php.

◆ getInstance()

the only code that instantiates Foo are implementations of and the only code that instantiates FooFactory is the instantiator in ServiceWiring php *As an intermediate Bar s constructor could initialize the $fooFactory member variable by calling MediaWikiServices::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 99 of file MediaWikiServices.php.

Referenced by MediaWiki\Auth\Throttler\__construct(), MediaWiki\Session\SessionManager\__construct(), MediaWiki\Shell\Shell\command(), SpecialNewFiles\execute(), BatchedQueryRunner\execute(), ImageBuilder\execute(), RebuildFileCache\finalSetup(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), MediaWiki\Auth\LegacyHookPreAuthenticationProviderTest\getProvider(), MediaWiki\Auth\LocalPasswordPrimaryAuthenticationProviderTest\getProvider(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\getProvider(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\preOutputCommit(), MediaWiki\restInPeace(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), MediaWiki\setDBProfilingAgent(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testCheckPasswordValidity(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetNewPasswordExpiry(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPassword(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testGetPasswordFactory(), GlobalTest\testReadOnlyEmpty(), GlobalTest\testReadOnlySet(), and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testSetPasswordResetFlag().

◆ getInterwikiLookup()

MediaWiki\MediaWikiServices::getInterwikiLookup ( )

Since: 1.28

Returns: InterwikiLookup

Definition at line 445 of file MediaWikiServices.php.

◆ getLinkCache()

MediaWiki\MediaWikiServices::getLinkCache ( )

Since: 1.28

Returns: LinkCache

Definition at line 598 of file MediaWikiServices.php.

◆ getLinkRenderer()

MediaWiki\MediaWikiServices::getLinkRenderer ( )

LinkRenderer instance that can be used if no custom options are needed.

Since: 1.28

Returns: LinkRenderer

Definition at line 617 of file MediaWikiServices.php.

◆ getLinkRendererFactory()

MediaWiki\MediaWikiServices::getLinkRendererFactory ( )

Since: 1.28

Returns: LinkRendererFactory

Definition at line 606 of file MediaWikiServices.php.

◆ getLocalServerObjectCache()

MediaWiki\MediaWikiServices::getLocalServerObjectCache ( )

Since: 1.28

Returns: \BagOStuff

Definition at line 657 of file MediaWikiServices.php.

◆ 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 421 of file MediaWikiServices.php.

◆ getMainObjectStash()

MediaWiki\MediaWikiServices::getMainObjectStash ( )

Since: 1.28

Returns: \BagOStuff

Definition at line 641 of file MediaWikiServices.php.

◆ getMainWANObjectCache()

MediaWiki\MediaWikiServices::getMainWANObjectCache ( )

Since: 1.28

Returns: \WANObjectCache

Definition at line 649 of file MediaWikiServices.php.

◆ getMediaHandlerFactory()

MediaWiki\MediaWikiServices::getMediaHandlerFactory ( )

Since: 1.28

Returns: MediaHandlerFactory

Definition at line 550 of file MediaWikiServices.php.

◆ getMimeAnalyzer()

MediaWiki\MediaWikiServices::getMimeAnalyzer ( )

Since: 1.28

Returns: MimeAnalyzer

Definition at line 558 of file MediaWikiServices.php.

◆ getParser()

MediaWiki\MediaWikiServices::getParser ( )

Since: 1.29

Returns: Parser

Definition at line 574 of file MediaWikiServices.php.

◆ getParserCache()

MediaWiki\MediaWikiServices::getParserCache ( )

Since: 1.30

Returns: ParserCache

Definition at line 582 of file MediaWikiServices.php.

◆ getProxyLookup()

MediaWiki\MediaWikiServices::getProxyLookup ( )

Since: 1.28

Returns: ProxyLookup

Definition at line 566 of file MediaWikiServices.php.

◆ getReadOnlyMode()

MediaWiki\MediaWikiServices::getReadOnlyMode ( )

Since: 1.29

Returns: \ReadOnlyMode

Definition at line 681 of file MediaWikiServices.php.

◆ getSearchEngineConfig()

MediaWiki\MediaWikiServices::getSearchEngineConfig ( )

Since: 1.27

Returns: SearchEngineConfig

Definition at line 486 of file MediaWikiServices.php.

◆ getSearchEngineFactory()

MediaWiki\MediaWikiServices::getSearchEngineFactory ( )

Since: 1.27

Returns: SearchEngineFactory

Definition at line 478 of file MediaWikiServices.php.

◆ getShellCommandFactory()

MediaWiki\MediaWikiServices::getShellCommandFactory ( )

Since: 1.30

Returns: CommandFactory

Definition at line 689 of file MediaWikiServices.php.

◆ getSiteLookup()

MediaWiki\MediaWikiServices::getSiteLookup ( )

Since: 1.27

Returns: SiteLookup

Definition at line 429 of file MediaWikiServices.php.

◆ getSiteStore()

MediaWiki\MediaWikiServices::getSiteStore ( )

Since: 1.27

Returns: SiteStore

Definition at line 437 of file MediaWikiServices.php.

◆ getSkinFactory()

MediaWiki\MediaWikiServices::getSkinFactory ( )

Since: 1.27

Returns: SkinFactory

Definition at line 494 of file MediaWikiServices.php.

◆ getStatsdDataFactory()

MediaWiki\MediaWikiServices::getStatsdDataFactory ( )

Since: 1.27

Returns: IBufferingStatsdDataFactory

Definition at line 453 of file MediaWikiServices.php.

◆ getTitleFormatter()

MediaWiki\MediaWikiServices::getTitleFormatter ( )

Since: 1.28

Returns: TitleFormatter

Definition at line 625 of file MediaWikiServices.php.

◆ getTitleParser()

MediaWiki\MediaWikiServices::getTitleParser ( )

Since: 1.28

Returns: TitleParser

Definition at line 633 of file MediaWikiServices.php.

◆ getVirtualRESTServiceClient()

MediaWiki\MediaWikiServices::getVirtualRESTServiceClient ( )

Since: 1.28

Returns: VirtualRESTServiceClient

Definition at line 665 of file MediaWikiServices.php.

◆ getWatchedItemQueryService()

MediaWiki\MediaWikiServices::getWatchedItemQueryService ( )

Since: 1.28

Returns: WatchedItemQueryService

Definition at line 526 of file MediaWikiServices.php.

◆ getWatchedItemStore()

MediaWiki\MediaWikiServices::getWatchedItemStore ( )

Since: 1.28

Returns: WatchedItemStore

Definition at line 518 of file MediaWikiServices.php.

◆ newInstance()

static MediaWiki\MediaWikiServices::newInstance	(	Config	$bootstrapConfig,
			$loadWiring = `''`
	)

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 242 of file MediaWikiServices.php.

References Hooks\run().

◆ newSearchEngine()

MediaWiki\MediaWikiServices::newSearchEngine ( )

Since: 1.27

Returns: SearchEngine

Definition at line 469 of file MediaWikiServices.php.

◆ resetChildProcessServices()

static MediaWiki\MediaWikiServices::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!

See also: resetGlobalInstance(); disableStorageBackend()

Definition at line 296 of file MediaWikiServices.php.

◆ resetGlobalInstance()

static MediaWiki\MediaWikiServices::resetGlobalInstance	(	Config	$bootstrapConfig = `null`,
			$quick = `''`
	)

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 175 of file MediaWikiServices.php.

Referenced by Installer\__construct().

◆ 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 327 of file MediaWikiServices.php.

References $name.

Referenced by MediaWikiTestCase\installTestServices().

◆ salvage()

MediaWiki\MediaWikiServices::salvage ( self $other )

private

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 206 of file MediaWikiServices.php.

References $e, $name, and as.

Member Data Documentation

◆ $instance

MediaWikiServices null MediaWiki\MediaWikiServices::$instance = null

staticprivate

Definition at line 83 of file MediaWikiServices.php.

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

includes/MediaWikiServices.php
docs/injection.txt

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ disableStorageBackend()

◆ failIfResetNotAllowed()

◆ forceGlobalInstance()

◆ getBootstrapConfig()

◆ getConfigFactory()

◆ getConfiguredReadOnlyMode()

◆ getCryptHKDF()

◆ getCryptRand()

◆ getDBLoadBalancer()

◆ getDBLoadBalancerFactory()

◆ getEventRelayerGroup()

◆ getGenderCache()

◆ getInstance()

◆ getInterwikiLookup()

◆ getLinkCache()

◆ getLinkRenderer()

◆ getLinkRendererFactory()

◆ getLocalServerObjectCache()

◆ getMainConfig()

◆ getMainObjectStash()

◆ getMainWANObjectCache()

◆ getMediaHandlerFactory()

◆ getMimeAnalyzer()

◆ getParser()

◆ getParserCache()

◆ getProxyLookup()

◆ getReadOnlyMode()

◆ getSearchEngineConfig()

◆ getSearchEngineFactory()

◆ getShellCommandFactory()

◆ getSiteLookup()

◆ getSiteStore()

◆ getSkinFactory()

◆ getStatsdDataFactory()

◆ getTitleFormatter()

◆ getTitleParser()

◆ getVirtualRESTServiceClient()

◆ getWatchedItemQueryService()

◆ getWatchedItemStore()

◆ newInstance()

◆ newSearchEngine()

◆ resetChildProcessServices()

◆ resetGlobalInstance()

◆ resetServiceForTesting()

◆ salvage()

Member Data Documentation

◆ $instance