MediaWiki REL1_35
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.
 
 getChangeTagDefStore ()
 
 getCommentStore ()
 
 getConfigFactory ()
 
 getConfigRepository ()
 
 getConfiguredReadOnlyMode ()
 
 getContentHandlerFactory ()
 
 getContentLanguage ()
 
 getContentModelChangeFactory ()
 
 getContentModelStore ()
 
 getContributionsLookup ()
 
 getCryptHKDF ()
 
 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.
 
 getLinkRendererFactory ()
 
 getLocalisationCache ()
 
 getLocalServerObjectCache ()
 
 getLockManagerGroupFactory ()
 
 getMagicWordFactory ()
 
 getMainConfig ()
 Returns the Config object that provides configuration for MediaWiki core.
 
 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.
 
 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 ()
 
 getWikiRevisionOldRevisionImporter ()
 
 getWikiRevisionOldRevisionImporterNoUpdates ()
 
 getWikiRevisionUploadImporter ()
 
 newSearchEngine ()
 
 resetServiceForTesting ( $name, $destroy=true)
 Resets the given service for testing purposes.
 

Static Public Member Functions

static disableStorageBackend ()
 Disables all storage layer services.
 
static failIfResetNotAllowed ( $method)
 Convenience method that throws an exception unless it is called during a phase in which resetting of global services is allowed.
 
static forceGlobalInstance (MediaWikiServices $services)
 Replaces the global MediaWikiServices instance.
 
static getInstance ()
 Returns the global default instance of the top level service locator.
 
static hasInstance ()
 Returns true if an instance has already been initialized.
 
static resetChildProcessServices ()
 Resets any services that may have become stale after a child process returns from after pcntl_fork().
 
static resetGlobalInstance (Config $bootstrapConfig=null, $quick='')
 Creates a new instance of MediaWikiServices and sets it as the global default instance.
 

Private Member Functions

 salvage (self $other)
 @noinspection PhpDocSignatureInspection
 

Static Private Member Functions

static newInstance (Config $bootstrapConfig, $loadWiring='')
 Creates a new MediaWikiServices instance and initializes it according to the given $bootstrapConfig.
 

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 152 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 470 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 364 of file MediaWikiServices.php.

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

◆ getActorMigration()

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

Definition at line 485 of file MediaWikiServices.php.

◆ getAuthManager()

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

Definition at line 493 of file MediaWikiServices.php.

◆ getBadFileLookup()

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

Definition at line 501 of file MediaWikiServices.php.

◆ getBlobStore()

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

Definition at line 509 of file MediaWikiServices.php.

◆ getBlobStoreFactory()

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

Definition at line 517 of file MediaWikiServices.php.

◆ getBlockErrorFormatter()

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

Definition at line 525 of file MediaWikiServices.php.

◆ getBlockManager()

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

Definition at line 533 of file MediaWikiServices.php.

◆ getBlockPermissionCheckerFactory()

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

Definition at line 541 of file MediaWikiServices.php.

◆ getBlockRestrictionStore()

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

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

◆ getChangeTagDefStore()

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

Definition at line 574 of file MediaWikiServices.php.

◆ getCommentStore()

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

Definition at line 582 of file MediaWikiServices.php.

◆ getConfigFactory()

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

Definition at line 590 of file MediaWikiServices.php.

◆ getConfigRepository()

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

Definition at line 598 of file MediaWikiServices.php.

◆ getConfiguredReadOnlyMode()

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

Definition at line 606 of file MediaWikiServices.php.

◆ getContentHandlerFactory()

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

Definition at line 614 of file MediaWikiServices.php.

◆ getContentLanguage()

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

Definition at line 622 of file MediaWikiServices.php.

◆ getContentModelChangeFactory()

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

Definition at line 630 of file MediaWikiServices.php.

◆ getContentModelStore()

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

Definition at line 638 of file MediaWikiServices.php.

◆ getContributionsLookup()

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

Definition at line 646 of file MediaWikiServices.php.

◆ getCryptHKDF()

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

Definition at line 654 of file MediaWikiServices.php.

◆ getDateFormatterFactory()

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

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

◆ getDBLoadBalancerFactory()

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

Definition at line 678 of file MediaWikiServices.php.

◆ getEmailer()

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

Definition at line 686 of file MediaWikiServices.php.

◆ getEventRelayerGroup()

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

Definition at line 694 of file MediaWikiServices.php.

◆ getExternalStoreAccess()

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

Definition at line 702 of file MediaWikiServices.php.

◆ getExternalStoreFactory()

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

Definition at line 710 of file MediaWikiServices.php.

◆ getFileBackendGroup()

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

Definition at line 718 of file MediaWikiServices.php.

◆ getGenderCache()

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

Definition at line 726 of file MediaWikiServices.php.

◆ getGlobalIdGenerator()

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

Definition at line 734 of file MediaWikiServices.php.

◆ getHookContainer()

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

Definition at line 742 of file MediaWikiServices.php.

◆ getHtmlCacheUpdater()

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

Definition at line 750 of file MediaWikiServices.php.

◆ getHttpRequestFactory()

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

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

Referenced by MediaWiki\Session\SessionManager\__construct(), MediaWiki\Rest\Router\__construct(), MediaWiki\Auth\Throttler\__construct(), MediaWiki\Preferences\DefaultPreferencesFactory\__construct(), MediaWiki\EditPage\TextConflictHelper\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Preferences\SignatureValidator\applyPreSaveTransform(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature(), MediaWiki\Block\DatabaseBlock\clearCookie(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Search\SearchWidgets\FullSearchResultWidget\generateFileHtml(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), MediaWiki\Block\DatabaseBlock\getBlocksForIPList(), MediaWiki\Block\DatabaseBlock\getCookieValue(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), MediaWiki\Block\DatabaseBlock\getIdFromCookieValue(), MediaWiki\Rest\EntryPoint\getMainRequest(), MediaWiki\Block\AbstractBlock\getPermissionsError(), MediaWiki\EditPage\TextboxBuilder\getTextboxProtectionCSSClasses(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\parseTitle(), MediaWiki\Search\SearchWidgets\SearchFormWidget\powerSearchBox(), 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\Linker\LinkRenderer\runLegacyBeginHook(), MediaWiki\Block\DatabaseBlock\setCookie(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Search\SearchWidgets\SearchFormWidget\startsWithImage(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\testUserForCreation(), MediaWiki\Revision\RevisionRecord\userCanBitfield(), MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature(), and MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ getInterwikiLookup()

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

Definition at line 766 of file MediaWikiServices.php.

◆ getJobRunner()

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

Definition at line 774 of file MediaWikiServices.php.

◆ getLanguageConverterFactory()

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

Definition at line 782 of file MediaWikiServices.php.

◆ getLanguageFactory()

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

Definition at line 790 of file MediaWikiServices.php.

◆ getLanguageFallback()

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

Definition at line 798 of file MediaWikiServices.php.

◆ getLanguageNameUtils()

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

Definition at line 806 of file MediaWikiServices.php.

◆ getLinkBatchFactory()

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

Definition at line 814 of file MediaWikiServices.php.

◆ getLinkCache()

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

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

◆ getLinkRendererFactory()

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

Definition at line 841 of file MediaWikiServices.php.

◆ getLocalisationCache()

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

Definition at line 849 of file MediaWikiServices.php.

◆ getLocalServerObjectCache()

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

Definition at line 857 of file MediaWikiServices.php.

◆ getLockManagerGroupFactory()

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

Definition at line 865 of file MediaWikiServices.php.

◆ getMagicWordFactory()

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

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

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

◆ getMainObjectStash()

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

Definition at line 892 of file MediaWikiServices.php.

◆ getMainWANObjectCache()

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

Definition at line 900 of file MediaWikiServices.php.

◆ getMediaHandlerFactory()

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

Definition at line 908 of file MediaWikiServices.php.

◆ getMergeHistoryFactory()

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

Definition at line 916 of file MediaWikiServices.php.

◆ getMessageCache()

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

Definition at line 924 of file MediaWikiServices.php.

◆ getMessageFormatterFactory()

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

Definition at line 932 of file MediaWikiServices.php.

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

◆ getMimeAnalyzer()

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

Definition at line 940 of file MediaWikiServices.php.

◆ getMovePageFactory()

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

Definition at line 948 of file MediaWikiServices.php.

◆ getNamespaceInfo()

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

Definition at line 956 of file MediaWikiServices.php.

◆ getNameTableStoreFactory()

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

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

◆ getOldRevisionImporter()

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

Definition at line 983 of file MediaWikiServices.php.

◆ getPageEditStash()

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

Definition at line 991 of file MediaWikiServices.php.

◆ getParser()

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

Definition at line 999 of file MediaWikiServices.php.

◆ getParserCache()

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

Definition at line 1007 of file MediaWikiServices.php.

◆ getParserFactory()

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

Definition at line 1015 of file MediaWikiServices.php.

◆ getPasswordFactory()

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

Definition at line 1023 of file MediaWikiServices.php.

◆ getPasswordReset()

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

Definition at line 1031 of file MediaWikiServices.php.

◆ getPerDbNameStatsdDataFactory()

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

Definition at line 1039 of file MediaWikiServices.php.

◆ getPermissionManager()

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

Definition at line 1047 of file MediaWikiServices.php.

◆ getPreferencesFactory()

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

Definition at line 1055 of file MediaWikiServices.php.

◆ getProxyLookup()

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

Definition at line 1063 of file MediaWikiServices.php.

◆ getReadOnlyMode()

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

Definition at line 1071 of file MediaWikiServices.php.

◆ getRepoGroup()

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

Definition at line 1079 of file MediaWikiServices.php.

◆ getResourceLoader()

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

Definition at line 1087 of file MediaWikiServices.php.

◆ getRevisionFactory()

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

Definition at line 1095 of file MediaWikiServices.php.

◆ getRevisionLookup()

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

Definition at line 1103 of file MediaWikiServices.php.

◆ getRevisionRenderer()

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

Definition at line 1111 of file MediaWikiServices.php.

◆ getRevisionStore()

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

Definition at line 1119 of file MediaWikiServices.php.

◆ getRevisionStoreFactory()

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

Definition at line 1127 of file MediaWikiServices.php.

◆ getSearchEngineConfig()

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

Definition at line 1144 of file MediaWikiServices.php.

Referenced by buildCommonApiParams().

◆ getSearchEngineFactory()

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

Definition at line 1152 of file MediaWikiServices.php.

◆ getShellCommandFactory()

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

Definition at line 1160 of file MediaWikiServices.php.

◆ getSiteLookup()

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

Definition at line 1168 of file MediaWikiServices.php.

◆ getSiteStore()

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

Definition at line 1176 of file MediaWikiServices.php.

◆ getSkinFactory()

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

Definition at line 1184 of file MediaWikiServices.php.

◆ getSlotRoleRegistry()

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

Definition at line 1192 of file MediaWikiServices.php.

◆ getSlotRoleStore()

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

Definition at line 1200 of file MediaWikiServices.php.

◆ getSpamChecker()

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

Definition at line 1208 of file MediaWikiServices.php.

◆ getSpecialPageFactory()

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

Definition at line 1216 of file MediaWikiServices.php.

◆ getStatsdDataFactory()

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

Definition at line 1224 of file MediaWikiServices.php.

◆ getTalkPageNotificationManager()

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

Definition at line 1232 of file MediaWikiServices.php.

◆ getTempFSFileFactory()

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

Definition at line 1240 of file MediaWikiServices.php.

◆ getTitleFactory()

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

Definition at line 1248 of file MediaWikiServices.php.

◆ getTitleFormatter()

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

Definition at line 1256 of file MediaWikiServices.php.

◆ getTitleParser()

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

Definition at line 1264 of file MediaWikiServices.php.

◆ getUploadRevisionImporter()

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

Definition at line 1272 of file MediaWikiServices.php.

◆ getUserEditTracker()

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

Definition at line 1280 of file MediaWikiServices.php.

◆ getUserFactory()

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

Definition at line 1288 of file MediaWikiServices.php.

◆ getUserGroupManager()

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

Definition at line 1296 of file MediaWikiServices.php.

◆ getUserGroupManagerFactory()

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

Definition at line 1304 of file MediaWikiServices.php.

◆ getUserNameUtils()

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

Definition at line 1312 of file MediaWikiServices.php.

◆ getUserOptionsLookup()

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

Definition at line 1320 of file MediaWikiServices.php.

◆ getUserOptionsManager()

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

Definition at line 1328 of file MediaWikiServices.php.

◆ getVirtualRESTServiceClient()

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

Definition at line 1336 of file MediaWikiServices.php.

◆ getWatchedItemQueryService()

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

Definition at line 1344 of file MediaWikiServices.php.

◆ getWatchedItemStore()

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

Definition at line 1352 of file MediaWikiServices.php.

◆ getWatchlistNotificationManager()

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

Definition at line 1360 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporter()

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

Definition at line 1368 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporterNoUpdates()

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

Definition at line 1376 of file MediaWikiServices.php.

◆ getWikiRevisionUploadImporter()

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

Definition at line 1384 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 165 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$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

\FatalError

Definition at line 337 of file MediaWikiServices.php.

References Config\get().

◆ newSearchEngine()

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

Definition at line 1135 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 388 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 263 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 419 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 301 of file MediaWikiServices.php.

Member Data Documentation

◆ $instance

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

Definition at line 157 of file MediaWikiServices.php.


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