MediaWiki  master
MediaWiki\MediaWikiServices Class Reference

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

Inheritance diagram for MediaWiki\MediaWikiServices:
Collaboration diagram for MediaWiki\MediaWikiServices:

Public Member Functions

 __construct (Config $config)
 
 getActorMigration ()
 
 getAuthManager ()
 
 getBadFileLookup ()
 
 getBlobStore ()
 
 getBlobStoreFactory ()
 
 getBlockErrorFormatter ()
 
 getBlockManager ()
 
 getBlockPermissionCheckerFactory ()
 
 getBlockRestrictionStore ()
 
 getBootstrapConfig ()
 Returns the Config object containing the bootstrap configuration. More...
 
 getChangeTagDefStore ()
 
 getCommentStore ()
 
 getConfigFactory ()
 
 getConfigRepository ()
 
 getConfiguredReadOnlyMode ()
 
 getContentHandlerFactory ()
 
 getContentLanguage ()
 
 getContentModelChangeFactory ()
 
 getContentModelStore ()
 
 getContributionsLookup ()
 
 getCryptHKDF ()
 
 getDatabaseBlockStore ()
 
 getDateFormatterFactory ()
 
 getDBLoadBalancer ()
 
 getDBLoadBalancerFactory ()
 
 getEmailer ()
 
 getEventRelayerGroup ()
 
 getExternalStoreAccess ()
 
 getExternalStoreFactory ()
 
 getFileBackendGroup ()
 
 getGenderCache ()
 
 getGlobalIdGenerator ()
 
 getHookContainer ()
 
 getHtmlCacheUpdater ()
 
 getHttpRequestFactory ()
 
 getInterwikiLookup ()
 
 getJobRunner ()
 
 getLanguageConverterFactory ()
 
 getLanguageFactory ()
 
 getLanguageFallback ()
 
 getLanguageNameUtils ()
 
 getLinkBatchFactory ()
 
 getLinkCache ()
 
 getLinkRenderer ()
 LinkRenderer instance that can be used if no custom options are needed. More...
 
 getLinkRendererFactory ()
 
 getLocalisationCache ()
 
 getLocalServerObjectCache ()
 
 getLockManagerGroupFactory ()
 
 getMagicWordFactory ()
 
 getMainConfig ()
 Returns the Config object that provides configuration for MediaWiki core. More...
 
 getMainObjectStash ()
 
 getMainWANObjectCache ()
 
 getMediaHandlerFactory ()
 
 getMergeHistoryFactory ()
 
 getMessageCache ()
 
 getMessageFormatterFactory ()
 
 getMimeAnalyzer ()
 
 getMovePageFactory ()
 
 getNamespaceInfo ()
 
 getNameTableStoreFactory ()
 
 getObjectFactory ()
 ObjectFactory is intended for instantiating "handlers" from declarative definitions, such as Action API modules, special pages, or REST API handlers. More...
 
 getOldRevisionImporter ()
 
 getPageEditStash ()
 
 getParser ()
 
 getParserCache ()
 
 getParserFactory ()
 
 getPasswordFactory ()
 
 getPasswordReset ()
 
 getPerDbNameStatsdDataFactory ()
 
 getPermissionManager ()
 
 getPreferencesFactory ()
 
 getProxyLookup ()
 
 getReadOnlyMode ()
 
 getRepoGroup ()
 
 getResourceLoader ()
 
 getRevisionFactory ()
 
 getRevisionLookup ()
 
 getRevisionRenderer ()
 
 getRevisionStore ()
 
 getRevisionStoreFactory ()
 
 getSearchEngineConfig ()
 
 getSearchEngineFactory ()
 
 getShellCommandFactory ()
 
 getSiteLookup ()
 
 getSiteStore ()
 
 getSkinFactory ()
 
 getSlotRoleRegistry ()
 
 getSlotRoleStore ()
 
 getSpamChecker ()
 
 getSpecialPageFactory ()
 
 getStatsdDataFactory ()
 
 getTalkPageNotificationManager ()
 
 getTempFSFileFactory ()
 
 getTitleFactory ()
 
 getTitleFormatter ()
 
 getTitleParser ()
 
 getUploadRevisionImporter ()
 
 getUserEditTracker ()
 
 getUserFactory ()
 
 getUserGroupManager ()
 
 getUserGroupManagerFactory ()
 
 getUserNameUtils ()
 
 getUserOptionsLookup ()
 
 getUserOptionsManager ()
 
 getVirtualRESTServiceClient ()
 
 getWatchedItemQueryService ()
 
 getWatchedItemStore ()
 
 getWatchlistNotificationManager ()
 
 getWikiPageFactory ()
 
 getWikiRevisionOldRevisionImporter ()
 
 getWikiRevisionOldRevisionImporterNoUpdates ()
 
 getWikiRevisionUploadImporter ()
 
 newSearchEngine ()
 
 resetServiceForTesting ( $name, $destroy=true)
 Resets the given service for testing purposes. 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
 

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

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\MediaWikiServices::__construct ( Config  $config)
Parameters
Config$configThe 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 472 of file MediaWikiServices.php.

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

References ObjectCache\clear().

◆ 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$methodthe name of the caller method, as given by METHOD.
Exceptions
MWExceptionif called outside bootstrap mode.
See also
resetGlobalInstance()
forceGlobalInstance()
disableStorageBackend()

Definition at line 456 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
MWExceptionif called outside of PHPUnit tests.
Parameters
MediaWikiServices$servicesThe new MediaWikiServices object.
Returns
MediaWikiServices The old MediaWikiServices object, so it can be restored later.

Definition at line 215 of file MediaWikiServices.php.

◆ getActorMigration()

MediaWiki\MediaWikiServices::getActorMigration ( )
Since
1.31
Returns
ActorMigration

Definition at line 487 of file MediaWikiServices.php.

◆ getAuthManager()

MediaWiki\MediaWikiServices::getAuthManager ( )
Since
1.35
Returns
AuthManager

Definition at line 495 of file MediaWikiServices.php.

◆ getBadFileLookup()

MediaWiki\MediaWikiServices::getBadFileLookup ( )
Since
1.34
Returns
BadFileLookup

Definition at line 503 of file MediaWikiServices.php.

◆ getBlobStore()

MediaWiki\MediaWikiServices::getBlobStore ( )
Since
1.31
Returns
BlobStore

Definition at line 511 of file MediaWikiServices.php.

◆ getBlobStoreFactory()

MediaWiki\MediaWikiServices::getBlobStoreFactory ( )
Since
1.31
Returns
BlobStoreFactory

Definition at line 519 of file MediaWikiServices.php.

◆ getBlockErrorFormatter()

MediaWiki\MediaWikiServices::getBlockErrorFormatter ( )
Since
1.35
Returns
BlockErrorFormatter

Definition at line 527 of file MediaWikiServices.php.

◆ getBlockManager()

MediaWiki\MediaWikiServices::getBlockManager ( )
Since
1.34
Returns
BlockManager

Definition at line 535 of file MediaWikiServices.php.

◆ getBlockPermissionCheckerFactory()

MediaWiki\MediaWikiServices::getBlockPermissionCheckerFactory ( )
Since
1.35
Returns
BlockPermissionCheckerFactory

Definition at line 543 of file MediaWikiServices.php.

◆ getBlockRestrictionStore()

MediaWiki\MediaWikiServices::getBlockRestrictionStore ( )
Since
1.33
Returns
BlockRestrictionStore

Definition at line 551 of file MediaWikiServices.php.

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

◆ getChangeTagDefStore()

MediaWiki\MediaWikiServices::getChangeTagDefStore ( )
Since
1.32
Returns
NameTableStore

Definition at line 576 of file MediaWikiServices.php.

◆ getCommentStore()

MediaWiki\MediaWikiServices::getCommentStore ( )
Since
1.31
Returns
CommentStore

Definition at line 584 of file MediaWikiServices.php.

◆ getConfigFactory()

MediaWiki\MediaWikiServices::getConfigFactory ( )
Since
1.27
Returns
ConfigFactory

Definition at line 592 of file MediaWikiServices.php.

◆ getConfigRepository()

MediaWiki\MediaWikiServices::getConfigRepository ( )
Since
1.32
Returns
ConfigRepository

Definition at line 600 of file MediaWikiServices.php.

◆ getConfiguredReadOnlyMode()

MediaWiki\MediaWikiServices::getConfiguredReadOnlyMode ( )
Since
1.29
Returns
ConfiguredReadOnlyMode

Definition at line 608 of file MediaWikiServices.php.

◆ getContentHandlerFactory()

MediaWiki\MediaWikiServices::getContentHandlerFactory ( )
Since
1.35
Returns
IContentHandlerFactory

Definition at line 616 of file MediaWikiServices.php.

◆ getContentLanguage()

MediaWiki\MediaWikiServices::getContentLanguage ( )
Since
1.32
Returns
Language

Definition at line 624 of file MediaWikiServices.php.

◆ getContentModelChangeFactory()

MediaWiki\MediaWikiServices::getContentModelChangeFactory ( )
Since
1.35
Returns
ContentModelChangeFactory

Definition at line 632 of file MediaWikiServices.php.

◆ getContentModelStore()

MediaWiki\MediaWikiServices::getContentModelStore ( )
Since
1.31
Returns
NameTableStore

Definition at line 640 of file MediaWikiServices.php.

◆ getContributionsLookup()

MediaWiki\MediaWikiServices::getContributionsLookup ( )
Since
1.35
Returns
ContributionsLookup

Definition at line 648 of file MediaWikiServices.php.

◆ getCryptHKDF()

MediaWiki\MediaWikiServices::getCryptHKDF ( )
Since
1.28
Returns
CryptHKDF

Definition at line 656 of file MediaWikiServices.php.

◆ getDatabaseBlockStore()

MediaWiki\MediaWikiServices::getDatabaseBlockStore ( )
Since
1.36
Returns
DatabaseBlockStore

Definition at line 664 of file MediaWikiServices.php.

◆ getDateFormatterFactory()

MediaWiki\MediaWikiServices::getDateFormatterFactory ( )
Since
1.33
Returns
DateFormatterFactory

Definition at line 672 of file MediaWikiServices.php.

◆ getDBLoadBalancer()

MediaWiki\MediaWikiServices::getDBLoadBalancer ( )
Since
1.28
Returns
ILoadBalancer The main DB load balancer for the local wiki.

Definition at line 680 of file MediaWikiServices.php.

◆ getDBLoadBalancerFactory()

MediaWiki\MediaWikiServices::getDBLoadBalancerFactory ( )
Since
1.28
Returns
LBFactory

Definition at line 688 of file MediaWikiServices.php.

◆ getEmailer()

MediaWiki\MediaWikiServices::getEmailer ( )
Since
1.35
Returns
IEmailer

Definition at line 696 of file MediaWikiServices.php.

◆ getEventRelayerGroup()

MediaWiki\MediaWikiServices::getEventRelayerGroup ( )
Since
1.27
Returns
EventRelayerGroup

Definition at line 704 of file MediaWikiServices.php.

◆ getExternalStoreAccess()

MediaWiki\MediaWikiServices::getExternalStoreAccess ( )
Since
1.34
Returns
ExternalStoreAccess

Definition at line 712 of file MediaWikiServices.php.

◆ getExternalStoreFactory()

MediaWiki\MediaWikiServices::getExternalStoreFactory ( )
Since
1.31
Returns
ExternalStoreFactory

Definition at line 720 of file MediaWikiServices.php.

◆ getFileBackendGroup()

MediaWiki\MediaWikiServices::getFileBackendGroup ( )
Since
1.35
Returns
FileBackendGroup

Definition at line 728 of file MediaWikiServices.php.

◆ getGenderCache()

MediaWiki\MediaWikiServices::getGenderCache ( )
Since
1.28
Returns
GenderCache

Definition at line 736 of file MediaWikiServices.php.

◆ getGlobalIdGenerator()

MediaWiki\MediaWikiServices::getGlobalIdGenerator ( )
Since
1.35
Returns
GlobalIdGenerator

Definition at line 744 of file MediaWikiServices.php.

◆ getHookContainer()

MediaWiki\MediaWikiServices::getHookContainer ( )
Since
1.35
Returns
HookContainer

Definition at line 752 of file MediaWikiServices.php.

◆ getHtmlCacheUpdater()

MediaWiki\MediaWikiServices::getHtmlCacheUpdater ( )
Since
1.35
Returns
HtmlCacheUpdater

Definition at line 760 of file MediaWikiServices.php.

◆ getHttpRequestFactory()

MediaWiki\MediaWikiServices::getHttpRequestFactory ( )
Since
1.31
Returns
HttpRequestFactory

Definition at line 768 of file MediaWikiServices.php.

◆ getInstance()

static MediaWiki\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 185 of file MediaWikiServices.php.

Referenced by MediaWiki\Auth\Throttler\__construct(), MediaWiki\Rest\Router\__construct(), MediaWiki\EditPage\TextConflictHelper\__construct(), MediaWiki\Preferences\DefaultPreferencesFactory\__construct(), MediaWiki\Session\SessionManager\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Preferences\SignatureValidator\applyPreSaveTransform(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), MediaWiki\User\UserGroupManager\checkCondition(), File\checkExtensionCompatibility(), MediaWiki\Preferences\SignatureValidator\checkLintErrors(), MediaWiki\Preferences\SignatureValidator\checkUserLinks(), MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature(), MediaWiki\Block\DatabaseBlock\clearCookie(), MediaWiki\Shell\Shell\command(), StreamFile\contentTypeFromPath(), MediaWiki\Rest\EntryPoint\createRouter(), MediaWiki\Block\DatabaseBlock\delete(), DeleteAutoPatrolLogs\deleteRows(), PopulateChangeTagDef\doDBUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), SpecialNewFiles\execute(), RunBatchedQuery\execute(), ImageBuilder\execute(), RebuildFileCache\finalSetup(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateFileHtml(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), 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\User\UserOptionsManager\getOptionKinds(), MediaWiki\Block\AbstractBlock\getPermissionsError(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), MediaWiki\EditPage\TextboxBuilder\getTextboxProtectionCSSClasses(), MediaHandler\getThumbType(), DjVuHandler\getThumbType(), UploadBase\getTitle(), ChannelFeed\httpHeaders(), MediaWiki\initializeArticle(), MediaWiki\Block\DatabaseBlock\insert(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), MediaWiki\Rest\EntryPoint\main(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\parseTitle(), MediaWiki\performRequest(), MediaWiki\Search\SearchWidgets\SearchFormWidget\powerSearchBox(), MediaWiki\preOutputCommit(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), MediaWiki\Block\AbstractBlock\prevents(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Block\DatabaseBlock\purgeExpired(), MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget\render(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\render(), MediaWiki\restInPeace(), MediaWiki\Block\DatabaseBlock\setBlocker(), MediaWiki\Block\DatabaseBlock\setCookie(), MediaWiki\setDBProfilingAgent(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Search\SearchWidgets\SearchFormWidget\startsWithImage(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\testUserForCreation(), MediaWiki\triggerAsyncJobs(), MediaWiki\triggerSyncJobs(), MediaWiki\tryNormaliseRedirect(), MediaWiki\Block\DatabaseBlock\update(), Revision\RevisionRecord\userCanBitfield(), MediaWiki\Preferences\SignatureValidator\validateSignature(), MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature(), UploadBase\verifyExtension(), and UploadBase\verifyMimeType().

◆ getInterwikiLookup()

MediaWiki\MediaWikiServices::getInterwikiLookup ( )
Since
1.28
Returns
InterwikiLookup

Definition at line 776 of file MediaWikiServices.php.

◆ getJobRunner()

MediaWiki\MediaWikiServices::getJobRunner ( )
Since
1.35
Returns
JobRunner

Definition at line 784 of file MediaWikiServices.php.

◆ getLanguageConverterFactory()

MediaWiki\MediaWikiServices::getLanguageConverterFactory ( )
Since
1.35
Returns
LanguageConverterFactory

Definition at line 792 of file MediaWikiServices.php.

◆ getLanguageFactory()

MediaWiki\MediaWikiServices::getLanguageFactory ( )
Since
1.35
Returns
LanguageFactory

Definition at line 800 of file MediaWikiServices.php.

◆ getLanguageFallback()

MediaWiki\MediaWikiServices::getLanguageFallback ( )
Since
1.35
Returns
LanguageFallback

Definition at line 808 of file MediaWikiServices.php.

◆ getLanguageNameUtils()

MediaWiki\MediaWikiServices::getLanguageNameUtils ( )
Since
1.34
Returns
LanguageNameUtils

Definition at line 816 of file MediaWikiServices.php.

◆ getLinkBatchFactory()

MediaWiki\MediaWikiServices::getLinkBatchFactory ( )
Since
1.35
Returns
LinkBatchFactory

Definition at line 824 of file MediaWikiServices.php.

◆ getLinkCache()

MediaWiki\MediaWikiServices::getLinkCache ( )
Since
1.28
Returns
LinkCache

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

◆ getLinkRendererFactory()

MediaWiki\MediaWikiServices::getLinkRendererFactory ( )
Since
1.28
Returns
LinkRendererFactory

Definition at line 851 of file MediaWikiServices.php.

◆ getLocalisationCache()

MediaWiki\MediaWikiServices::getLocalisationCache ( )
Since
1.34
Returns
LocalisationCache

Definition at line 859 of file MediaWikiServices.php.

◆ getLocalServerObjectCache()

MediaWiki\MediaWikiServices::getLocalServerObjectCache ( )
Since
1.28
Returns
BagOStuff

Definition at line 867 of file MediaWikiServices.php.

◆ getLockManagerGroupFactory()

MediaWiki\MediaWikiServices::getLockManagerGroupFactory ( )
Since
1.34
Returns
LockManagerGroupFactory

Definition at line 875 of file MediaWikiServices.php.

◆ getMagicWordFactory()

MediaWiki\MediaWikiServices::getMagicWordFactory ( )
Since
1.32
Returns
MagicWordFactory

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

Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().

◆ getMainObjectStash()

MediaWiki\MediaWikiServices::getMainObjectStash ( )
Since
1.28
Returns
BagOStuff

Definition at line 902 of file MediaWikiServices.php.

◆ getMainWANObjectCache()

MediaWiki\MediaWikiServices::getMainWANObjectCache ( )
Since
1.28
Returns
WANObjectCache

Definition at line 910 of file MediaWikiServices.php.

◆ getMediaHandlerFactory()

MediaWiki\MediaWikiServices::getMediaHandlerFactory ( )
Since
1.28
Returns
MediaHandlerFactory

Definition at line 918 of file MediaWikiServices.php.

◆ getMergeHistoryFactory()

MediaWiki\MediaWikiServices::getMergeHistoryFactory ( )
Since
1.35
Returns
MergeHistoryFactory

Definition at line 926 of file MediaWikiServices.php.

◆ getMessageCache()

MediaWiki\MediaWikiServices::getMessageCache ( )
Since
1.34
Returns
MessageCache

Definition at line 934 of file MediaWikiServices.php.

◆ getMessageFormatterFactory()

MediaWiki\MediaWikiServices::getMessageFormatterFactory ( )
Since
1.34
Returns
IMessageFormatterFactory

Definition at line 942 of file MediaWikiServices.php.

Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().

◆ getMimeAnalyzer()

MediaWiki\MediaWikiServices::getMimeAnalyzer ( )
Since
1.28
Returns
MimeAnalyzer

Definition at line 950 of file MediaWikiServices.php.

◆ getMovePageFactory()

MediaWiki\MediaWikiServices::getMovePageFactory ( )
Since
1.34
Returns
MovePageFactory

Definition at line 958 of file MediaWikiServices.php.

◆ getNamespaceInfo()

MediaWiki\MediaWikiServices::getNamespaceInfo ( )
Since
1.34
Returns
NamespaceInfo

Definition at line 966 of file MediaWikiServices.php.

◆ getNameTableStoreFactory()

MediaWiki\MediaWikiServices::getNameTableStoreFactory ( )
Since
1.32
Returns
NameTableStoreFactory

Definition at line 974 of file MediaWikiServices.php.

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

◆ getOldRevisionImporter()

MediaWiki\MediaWikiServices::getOldRevisionImporter ( )
Since
1.32
Returns
OldRevisionImporter

Definition at line 993 of file MediaWikiServices.php.

◆ getPageEditStash()

MediaWiki\MediaWikiServices::getPageEditStash ( )
Returns
PageEditStash
Since
1.34

Definition at line 1001 of file MediaWikiServices.php.

◆ getParser()

MediaWiki\MediaWikiServices::getParser ( )
Since
1.29
Returns
Parser

Definition at line 1009 of file MediaWikiServices.php.

◆ getParserCache()

MediaWiki\MediaWikiServices::getParserCache ( )
Since
1.30
Returns
ParserCache

Definition at line 1017 of file MediaWikiServices.php.

◆ getParserFactory()

MediaWiki\MediaWikiServices::getParserFactory ( )
Since
1.32
Returns
ParserFactory

Definition at line 1025 of file MediaWikiServices.php.

◆ getPasswordFactory()

MediaWiki\MediaWikiServices::getPasswordFactory ( )
Since
1.32
Returns
PasswordFactory

Definition at line 1033 of file MediaWikiServices.php.

◆ getPasswordReset()

MediaWiki\MediaWikiServices::getPasswordReset ( )
Since
1.34
Returns
PasswordReset

Definition at line 1041 of file MediaWikiServices.php.

◆ getPerDbNameStatsdDataFactory()

MediaWiki\MediaWikiServices::getPerDbNameStatsdDataFactory ( )
Since
1.32
Returns
StatsdDataFactoryInterface

Definition at line 1049 of file MediaWikiServices.php.

◆ getPermissionManager()

MediaWiki\MediaWikiServices::getPermissionManager ( )
Since
1.33
Returns
PermissionManager

Definition at line 1057 of file MediaWikiServices.php.

◆ getPreferencesFactory()

MediaWiki\MediaWikiServices::getPreferencesFactory ( )
Since
1.31
Returns
PreferencesFactory

Definition at line 1065 of file MediaWikiServices.php.

◆ getProxyLookup()

MediaWiki\MediaWikiServices::getProxyLookup ( )
Since
1.28
Returns
ProxyLookup

Definition at line 1073 of file MediaWikiServices.php.

◆ getReadOnlyMode()

MediaWiki\MediaWikiServices::getReadOnlyMode ( )
Since
1.29
Returns
ReadOnlyMode

Definition at line 1081 of file MediaWikiServices.php.

◆ getRepoGroup()

MediaWiki\MediaWikiServices::getRepoGroup ( )
Since
1.34
Returns
RepoGroup

Definition at line 1089 of file MediaWikiServices.php.

◆ getResourceLoader()

MediaWiki\MediaWikiServices::getResourceLoader ( )
Since
1.33
Returns
ResourceLoader

Definition at line 1097 of file MediaWikiServices.php.

◆ getRevisionFactory()

MediaWiki\MediaWikiServices::getRevisionFactory ( )
Since
1.31
Returns
RevisionFactory

Definition at line 1105 of file MediaWikiServices.php.

◆ getRevisionLookup()

MediaWiki\MediaWikiServices::getRevisionLookup ( )
Since
1.31
Returns
RevisionLookup

Definition at line 1113 of file MediaWikiServices.php.

◆ getRevisionRenderer()

MediaWiki\MediaWikiServices::getRevisionRenderer ( )
Since
1.32
Returns
RevisionRenderer

Definition at line 1121 of file MediaWikiServices.php.

◆ getRevisionStore()

MediaWiki\MediaWikiServices::getRevisionStore ( )
Since
1.31
Returns
RevisionStore

Definition at line 1129 of file MediaWikiServices.php.

◆ getRevisionStoreFactory()

MediaWiki\MediaWikiServices::getRevisionStoreFactory ( )
Since
1.32
Returns
RevisionStoreFactory

Definition at line 1137 of file MediaWikiServices.php.

◆ getSearchEngineConfig()

MediaWiki\MediaWikiServices::getSearchEngineConfig ( )
Since
1.27
Returns
SearchEngineConfig

Definition at line 1154 of file MediaWikiServices.php.

◆ getSearchEngineFactory()

MediaWiki\MediaWikiServices::getSearchEngineFactory ( )
Since
1.27
Returns
SearchEngineFactory

Definition at line 1162 of file MediaWikiServices.php.

◆ getShellCommandFactory()

MediaWiki\MediaWikiServices::getShellCommandFactory ( )
Since
1.30
Returns
CommandFactory

Definition at line 1170 of file MediaWikiServices.php.

◆ getSiteLookup()

MediaWiki\MediaWikiServices::getSiteLookup ( )
Since
1.27
Returns
SiteLookup

Definition at line 1178 of file MediaWikiServices.php.

◆ getSiteStore()

MediaWiki\MediaWikiServices::getSiteStore ( )
Since
1.27
Returns
SiteStore

Definition at line 1186 of file MediaWikiServices.php.

◆ getSkinFactory()

MediaWiki\MediaWikiServices::getSkinFactory ( )
Since
1.27
Returns
SkinFactory

Definition at line 1194 of file MediaWikiServices.php.

◆ getSlotRoleRegistry()

MediaWiki\MediaWikiServices::getSlotRoleRegistry ( )
Since
1.33
Returns
SlotRoleRegistry

Definition at line 1202 of file MediaWikiServices.php.

◆ getSlotRoleStore()

MediaWiki\MediaWikiServices::getSlotRoleStore ( )
Since
1.31
Returns
NameTableStore

Definition at line 1210 of file MediaWikiServices.php.

◆ getSpamChecker()

MediaWiki\MediaWikiServices::getSpamChecker ( )
Since
1.35
Returns
SpamChecker

Definition at line 1218 of file MediaWikiServices.php.

◆ getSpecialPageFactory()

MediaWiki\MediaWikiServices::getSpecialPageFactory ( )
Since
1.32
Returns
SpecialPageFactory

Definition at line 1226 of file MediaWikiServices.php.

◆ getStatsdDataFactory()

MediaWiki\MediaWikiServices::getStatsdDataFactory ( )
Since
1.27
Returns
IBufferingStatsdDataFactory

Definition at line 1234 of file MediaWikiServices.php.

◆ getTalkPageNotificationManager()

MediaWiki\MediaWikiServices::getTalkPageNotificationManager ( )
Since
1.35
Returns
TalkPageNotificationManager

Definition at line 1242 of file MediaWikiServices.php.

◆ getTempFSFileFactory()

MediaWiki\MediaWikiServices::getTempFSFileFactory ( )
Since
1.34
Returns
TempFSFileFactory

Definition at line 1250 of file MediaWikiServices.php.

◆ getTitleFactory()

MediaWiki\MediaWikiServices::getTitleFactory ( )
Since
1.35
Returns
TitleFactory

Definition at line 1258 of file MediaWikiServices.php.

◆ getTitleFormatter()

MediaWiki\MediaWikiServices::getTitleFormatter ( )
Since
1.28
Returns
TitleFormatter

Definition at line 1266 of file MediaWikiServices.php.

◆ getTitleParser()

MediaWiki\MediaWikiServices::getTitleParser ( )
Since
1.28
Returns
TitleParser

Definition at line 1274 of file MediaWikiServices.php.

◆ getUploadRevisionImporter()

MediaWiki\MediaWikiServices::getUploadRevisionImporter ( )
Since
1.32
Returns
UploadRevisionImporter

Definition at line 1282 of file MediaWikiServices.php.

◆ getUserEditTracker()

MediaWiki\MediaWikiServices::getUserEditTracker ( )
Since
1.35
Returns
UserEditTracker

Definition at line 1290 of file MediaWikiServices.php.

◆ getUserFactory()

MediaWiki\MediaWikiServices::getUserFactory ( )
Since
1.35
Returns
UserFactory

Definition at line 1298 of file MediaWikiServices.php.

◆ getUserGroupManager()

MediaWiki\MediaWikiServices::getUserGroupManager ( )
Since
1.35
Returns
UserGroupManager

Definition at line 1306 of file MediaWikiServices.php.

◆ getUserGroupManagerFactory()

MediaWiki\MediaWikiServices::getUserGroupManagerFactory ( )
Since
1.35
Returns
UserGroupManagerFactory

Definition at line 1314 of file MediaWikiServices.php.

◆ getUserNameUtils()

MediaWiki\MediaWikiServices::getUserNameUtils ( )
Since
1.35
Returns
UserNameUtils

Definition at line 1322 of file MediaWikiServices.php.

◆ getUserOptionsLookup()

MediaWiki\MediaWikiServices::getUserOptionsLookup ( )
Since
1.35
Returns
UserOptionsLookup

Definition at line 1330 of file MediaWikiServices.php.

◆ getUserOptionsManager()

MediaWiki\MediaWikiServices::getUserOptionsManager ( )
Since
1.35
Returns
UserOptionsManager

Definition at line 1338 of file MediaWikiServices.php.

◆ getVirtualRESTServiceClient()

MediaWiki\MediaWikiServices::getVirtualRESTServiceClient ( )
Since
1.28
Returns
VirtualRESTServiceClient

Definition at line 1346 of file MediaWikiServices.php.

◆ getWatchedItemQueryService()

MediaWiki\MediaWikiServices::getWatchedItemQueryService ( )
Since
1.28
Returns
WatchedItemQueryService

Definition at line 1354 of file MediaWikiServices.php.

◆ getWatchedItemStore()

MediaWiki\MediaWikiServices::getWatchedItemStore ( )
Since
1.28
Returns
WatchedItemStoreInterface

Definition at line 1362 of file MediaWikiServices.php.

◆ getWatchlistNotificationManager()

MediaWiki\MediaWikiServices::getWatchlistNotificationManager ( )
Since
1.35
Returns
WatchlistNotificationManager

Definition at line 1370 of file MediaWikiServices.php.

◆ getWikiPageFactory()

MediaWiki\MediaWikiServices::getWikiPageFactory ( )
Since
1.36
Returns
WikiPageFactory

Definition at line 1378 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporter()

MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporter ( )
Since
1.31
Returns
OldRevisionImporter

Definition at line 1386 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporterNoUpdates()

MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporterNoUpdates ( )
Since
1.31
Returns
OldRevisionImporter

Definition at line 1394 of file MediaWikiServices.php.

◆ getWikiRevisionUploadImporter()

MediaWiki\MediaWikiServices::getWikiRevisionUploadImporter ( )
Since
1.31
Returns
UploadRevisionImporter

Definition at line 1402 of file MediaWikiServices.php.

◆ hasInstance()

static MediaWiki\MediaWikiServices::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 167 of file MediaWikiServices.php.

Referenced by MediaWiki\Languages\LanguageFactory\getLanguage().

◆ 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$bootstrapConfigThe Config object to be registered as the 'BootstrapConfig' service.
string$loadWiringset this to 'load' to load the wiring files specified in the 'ServiceWiringFiles' setting in $bootstrapConfig.
Returns
MediaWikiServices
Exceptions
MWException

Definition at line 339 of file MediaWikiServices.php.

References Config\get().

◆ newSearchEngine()

MediaWiki\MediaWikiServices::newSearchEngine ( )
Since
1.27
Returns
SearchEngine

Definition at line 1145 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 390 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$bootstrapConfigThe 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$quickSet this to "quick" to allow expensive resources to be re-used. See SalvageableService for details.
Exceptions
MWExceptionIf 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 265 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$destroyWhether 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
MWExceptionif called outside of PHPUnit tests.

Definition at line 421 of file MediaWikiServices.php.

◆ salvage()

MediaWiki\MediaWikiServices::salvage ( self  $other)
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 303 of file MediaWikiServices.php.

Member Data Documentation

◆ $instance

MediaWikiServices null MediaWiki\MediaWikiServices::$instance = null
staticprivate

Definition at line 159 of file MediaWikiServices.php.


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