Service locator for MediaWiki core services. More...

Inherits ServiceContainer.

Collaboration diagram for MediaWiki\MediaWikiServices:

Public Member Functions
	__construct (Config $config)

	disableStorage ()
	Disables all storage layer services.

	getActionFactory ()

	getActorMigration ()

	getActorNormalization ()

	getActorStore ()

	getActorStoreFactory ()

	getArchivedRevisionLookup ()

	getAuthManager ()

	getAutoblockExemptionList ()

	getBacklinkCacheFactory ()

	getBadFileLookup ()

	getBlobStore ()

	getBlobStoreFactory ()

	getBlockActionInfo ()

	getBlockErrorFormatter ()

	getBlockManager ()

	getBlockPermissionCheckerFactory ()

	getBlockRestrictionStore ()

	getBlockRestrictionStoreFactory ()

	getBlockTargetFactory ()

	getBlockUserFactory ()

	getBlockUtils ()

	getBlockUtilsFactory ()

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

	getBotPasswordStore ()

	getCentralIdLookup ()

	getCentralIdLookupFactory ()

	getChangesListQueryFactory ()

	getChangeTagDefStore ()

	getChangeTagsStore ()

	getChangeTagsStoreFactory ()

	getChronologyProtector ()

	getCollationFactory ()

	getCommentFormatter ()

	getCommentParserFactory ()

	getCommentStore ()

	getConfigFactory ()

	getConfigRepository ()

	getConfigSchema ()

	getConfiguredReadOnlyMode ()

	getConfirmEmailBuilderFactory ()

	getConfirmEmailSender ()

	getConnectionProvider ()

	getContentHandlerFactory ()

	getContentJsonCodec ()

	getContentLanguage ()

	getContentLanguageCode ()

	getContentModelChangeFactory ()

	getContentModelStore ()

	getContentRenderer ()

	getContentTransformer ()

	getCriticalSectionProvider ()

	getCrossWikiBlockTargetFactory ()

	getDatabaseBlockStore ()

	getDatabaseBlockStoreFactory ()

	getDatabaseFactory ()

	getDateFormatterFactory ()

	getDBLoadBalancer ()

	getDBLoadBalancerFactory ()

	getDBLoadBalancerFactoryConfigBuilder ()

	getDefaultOutputPipeline ()

	getDeletePageFactory ()

	getDomainEventDispatcher ()

	getDomainEventSource ()

	getEmailer ()

	getEmailUserFactory ()

	getEventRelayerGroup ()

	getExtensionRegistry ()

	getExternalStoreAccess ()

	getExternalStoreFactory ()

	getFeatureShutdown ()

	getFileBackendGroup ()

	getFormatterFactory ()

	getGenderCache ()

	getGlobalIdGenerator ()

	getGrantsInfo ()

	getGrantsLocalization ()

	getGroupPermissionsLookup ()

	getHideUserUtils ()

	getHookContainer ()

	getHtmlCacheUpdater ()

	getHtmlTransformFactory ()

	getHttpRequestFactory ()

	getInterwikiLookup ()

	getIntroMessageBuilder ()

	getJobFactory ()

	getJobQueueGroup ()

	getJobQueueGroupFactory ()

	getJobRunner ()

	getJsonCodec ()

	getJwtCodec ()

	getLanguageConverterFactory ()

	getLanguageFactory ()

	getLanguageFallback ()

	getLanguageNameSearch ()

	getLanguageNameUtils ()

	getLeximorphFactory ()

	getLinkBatchFactory ()

	getLinkCache ()

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

	getLinkRendererFactory ()

	getLinksMigration ()

	getLinkTargetLookup ()

	getLinkWriteDuplicator ()

	getLintErrorChecker ()

	getLocalisationCache ()

	getLocalServerObjectCache ()
	Returns the main server-local cache, yielding EmptyBagOStuff if there is none.

	getLockManagerGroupFactory ()

	getLogFormatterFactory ()

	getMagicWordFactory ()

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

	getMainObjectStash ()
	Returns the main object stash, yielding EmptyBagOStuff if there is none.

	getMainWANObjectCache ()
	Returns the main WAN cache, yielding EmptyBagOStuff if there is none.

	getMediaHandlerFactory ()

	getMergeHistoryFactory ()

	getMessageCache ()

	getMessageFormatterFactory ()

	getMessageParser ()

	getMicroStash ()

	getMimeAnalyzer ()

	getMovePageFactory ()

	getMultiFormatUserIdentityLookup ()

	getNamespaceInfo ()

	getNameTableStoreFactory ()

	getNotificationEmailSender ()

	getNotificationService ()

	getObjectCacheFactory ()

	getObjectFactory ()
	ObjectFactory is intended for instantiating "handlers" from declarative definitions, such as Action API modules, special pages, or REST API handlers.

	getOldRevisionImporter ()

	getPageEditStash ()

	getPageProps ()

	getPageRestHelperFactory ()

	getPageStore ()

	getPageStoreFactory ()

	getPageUpdaterFactory ()

	getParser ()
	Get the main Parser instance.

	getParserCache ()

	getParserCacheFactory ()

	getParserFactory ()

	getParserOutputAccess ()

	getParsoidDataAccess ()

	getParsoidOutputStash ()

	getParsoidPageConfigFactory ()

	getParsoidParserFactory ()

	getParsoidSiteConfig ()

	getPasswordFactory ()

	getPasswordReset ()

	getPatrolManager ()

	getPerDbNameStatsdDataFactory ()

	getPermissionManager ()

	getPingback ()

	getPoolCounterFactory ()

	getPreferencesFactory ()

	getPreloadedContentBuilder ()

	getProxyLookup ()

	getRateLimiter ()

	getReadOnlyMode ()

	getRecentChangeFactory ()

	getRecentChangeLookup ()

	getRecentChangeRCFeedNotifier ()

	getRecentChangeStore ()

	getRedirectLookup ()

	getRedirectStore ()

	getRenameUserFactory ()

	getRepoGroup ()

	getResourceLoader ()

	getRestrictedUserGroupCheckerFactory ()

	getRestrictedUserGroupConfigReader ()

	getRestrictionStore ()

	getRevertedTagUpdateManager ()

	getRevisionFactory ()

	getRevisionLookup ()

	getRevisionRenderer ()

	getRevisionStore ()

	getRevisionStoreFactory ()

	getRollbackPageFactory ()

	getRowCommentFormatter ()

	getSearchEngineConfig ()

	getSearchEngineFactory ()

	getSearchResultThumbnailProvider ()

	getService ( $name)

	getSessionManager ()

	getSessionStore ()

	getShellboxClientFactory ()

	getShellCommandFactory ()

	getSignatureValidatorFactory ()

	getSiteLookup ()

	getSiteStore ()

	getSkinFactory ()

	getSlotRoleRegistry ()

	getSlotRoleStore ()

	getSpamChecker ()

	getSpecialPageFactory ()

	getStatsdDataFactory ()

	getStatsFactory ()

	getTalkPageNotificationManager ()

	getTempFSFileFactory ()

	getTempUserConfig ()

	getTempUserCreator ()

	getTempUserDetailsLookup ()

	getTidy ()

	getTitleFactory ()

	getTitleFormatter ()

	getTitleMatcher ()

	getTitleParser ()

	getTracer ()

	getTrackingCategories ()

	getUnblockUserFactory ()

	getUndeletePageFactory ()

	getUploadRevisionImporter ()

	getUploadVerification ()

	getUrlUtils ()

	getUserCache ()

	getUserEditTracker ()

	getUserFactory ()

	getUserGroupAssignmentService ()

	getUserGroupManager ()

	getUserGroupManagerFactory ()

	getUserIdentityLookup ()

	getUserIdentityUtils ()

	getUserLinkRenderer ()

	getUserNamePrefixSearch ()

	getUserNameUtils ()

	getUserOptionsLookup ()

	getUserOptionsManager ()

	getUserRegistrationLookup ()

	getUserRequirementsConditionChecker ()

	getUserRequirementsConditionCheckerFactory ()

	getWatchedItemQueryService ()

	getWatchedItemStore ()

	getWatchlistLabelStore ()

	getWatchlistManager ()

	getWikiExporterFactory ()

	getWikiImporterFactory ()

	getWikiPageFactory ()

	getWikiRevisionOldRevisionImporter ()

	getWikiRevisionOldRevisionImporterNoUpdates ()

	getWikiRevisionUploadImporter ()

	getWRStatsFactory ()

	isStorageDisabled ()
	Returns true if disableStorage() has been called on this MediaWikiServices instance.

	newSearchEngine ()

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

Static Public Member Functions
static	allowGlobalInstance ()
	Allows a global service container instance to exist.

static	allowGlobalInstanceAfterUnitTests ()

static	disableStorageBackend ()
	Disables all storage layer services.

static	disallowGlobalInstanceInUnitTests ()

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 (self $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 and can be obtained from getInstance().

static	resetChildProcessServices ()
	Resets any services that may have become stale after a child processö returns from after pcntl_fork().

static	resetGlobalInstance (?Config $bootstrapConfig=null, $mode='reset')
	Creates a new instance of MediaWikiServices and sets it as the global default instance.

Detailed Description

Service locator for MediaWiki core services.

Refer to includes/ServiceWiring.php for the default implementations.

See also: Dependency Injection in docs/Injection.md for the principles of DI and how to use it MediaWiki core.

Since: 1.27

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

Member Function Documentation

◆ allowGlobalInstance()

static MediaWiki\MediaWikiServices::allowGlobalInstance ( )

static

Allows a global service container instance to exist.

This should be called only after configuration settings have been read and extensions have been registered. Any change made to configuration after this method has been called may be ineffective or even harmful.

See also: getInstance()

Since: 1.36

Definition at line 290 of file MediaWikiServices.php.

◆ allowGlobalInstanceAfterUnitTests()

static MediaWiki\MediaWikiServices::allowGlobalInstanceAfterUnitTests ( )

static

Access: internal: Should only be used in MediaWikiUnitTestCase

Definition at line 314 of file MediaWikiServices.php.

◆ disableStorage()

MediaWiki\MediaWikiServices::disableStorage ( )

Disables all storage layer services.

After calling this, any attempt to access the storage layer will result in an error. Use resetGlobalInstance() with $mode=reload to restore normal operation.

Since: 1.40

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

References MediaWiki\Language\LocalisationCache\disableBackend().

◆ 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.

Since: 1.28

Deprecated: since 1.40, use disableStorage() instead. Hard deprecated in 1.45.

Warning: This is intended for extreme situations, see the documentation of disableStorage() for details.

See also: resetGlobalInstance(); resetChildProcessServices()

Definition at line 535 of file MediaWikiServices.php.

References wfDeprecated().

◆ disallowGlobalInstanceInUnitTests()

static MediaWiki\MediaWikiServices::disallowGlobalInstanceInUnitTests ( )

static

Access: internal: Should only be used in MediaWikiUnitTestCase

Definition at line 304 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 $method the name of the caller method, as given by METHOD.

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

Definition at line 692 of file MediaWikiServices.php.

◆ forceGlobalInstance()

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

static

Replaces the global MediaWikiServices instance.

Since: 1.28

Note: This is for use in PHPUnit tests only!

Parameters

self $services The new MediaWikiServices object.

Returns: self The old MediaWikiServices object, so it can be restored later.

Definition at line 395 of file MediaWikiServices.php.

◆ getActionFactory()

MediaWiki\MediaWikiServices::getActionFactory ( )

Since: 1.37

Definition at line 721 of file MediaWikiServices.php.

◆ getActorMigration()

MediaWiki\MediaWikiServices::getActorMigration ( )

Since: 1.31

Definition at line 728 of file MediaWikiServices.php.

◆ getActorNormalization()

MediaWiki\MediaWikiServices::getActorNormalization ( )

Since: 1.36

Definition at line 735 of file MediaWikiServices.php.

◆ getActorStore()

MediaWiki\MediaWikiServices::getActorStore ( )

Since: 1.36

Definition at line 742 of file MediaWikiServices.php.

◆ getActorStoreFactory()

MediaWiki\MediaWikiServices::getActorStoreFactory ( )

Since: 1.36

Definition at line 749 of file MediaWikiServices.php.

◆ getArchivedRevisionLookup()

MediaWiki\MediaWikiServices::getArchivedRevisionLookup ( )

Since: 1.38

Definition at line 756 of file MediaWikiServices.php.

◆ getAuthManager()

MediaWiki\MediaWikiServices::getAuthManager ( )

Since: 1.35

Definition at line 763 of file MediaWikiServices.php.

◆ getAutoblockExemptionList()

MediaWiki\MediaWikiServices::getAutoblockExemptionList ( )

Since: 1.42

Definition at line 770 of file MediaWikiServices.php.

◆ getBacklinkCacheFactory()

MediaWiki\MediaWikiServices::getBacklinkCacheFactory ( )

Since: 1.37

Definition at line 777 of file MediaWikiServices.php.

◆ getBadFileLookup()

MediaWiki\MediaWikiServices::getBadFileLookup ( )

Since: 1.34

Definition at line 784 of file MediaWikiServices.php.

◆ getBlobStore()

MediaWiki\MediaWikiServices::getBlobStore ( )

Since: 1.31

Definition at line 791 of file MediaWikiServices.php.

◆ getBlobStoreFactory()

MediaWiki\MediaWikiServices::getBlobStoreFactory ( )

Since: 1.31

Definition at line 798 of file MediaWikiServices.php.

◆ getBlockActionInfo()

MediaWiki\MediaWikiServices::getBlockActionInfo ( )

Since: 1.37

Definition at line 805 of file MediaWikiServices.php.

◆ getBlockErrorFormatter()

MediaWiki\MediaWikiServices::getBlockErrorFormatter ( )

Since: 1.35

Deprecated: since 1.42, use getFormatterFactory()->getBlockErrorFormatter() instead.

Definition at line 813 of file MediaWikiServices.php.

◆ getBlockManager()

MediaWiki\MediaWikiServices::getBlockManager ( )

Since: 1.34

Definition at line 821 of file MediaWikiServices.php.

◆ getBlockPermissionCheckerFactory()

MediaWiki\MediaWikiServices::getBlockPermissionCheckerFactory ( )

Since: 1.35

Definition at line 828 of file MediaWikiServices.php.

◆ getBlockRestrictionStore()

MediaWiki\MediaWikiServices::getBlockRestrictionStore ( )

Since: 1.33

Definition at line 835 of file MediaWikiServices.php.

◆ getBlockRestrictionStoreFactory()

MediaWiki\MediaWikiServices::getBlockRestrictionStoreFactory ( )

Since: 1.38

Definition at line 842 of file MediaWikiServices.php.

◆ getBlockTargetFactory()

MediaWiki\MediaWikiServices::getBlockTargetFactory ( )

Since: 1.44

Definition at line 849 of file MediaWikiServices.php.

◆ getBlockUserFactory()

MediaWiki\MediaWikiServices::getBlockUserFactory ( )

Since: 1.36

Definition at line 856 of file MediaWikiServices.php.

◆ getBlockUtils()

MediaWiki\MediaWikiServices::getBlockUtils ( )

Deprecated: since 1.44

Since: 1.36

Definition at line 864 of file MediaWikiServices.php.

◆ getBlockUtilsFactory()

MediaWiki\MediaWikiServices::getBlockUtilsFactory ( )

Deprecated: since 1.44

Since: 1.42

Definition at line 872 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

Definition at line 888 of file MediaWikiServices.php.

◆ getBotPasswordStore()

MediaWiki\MediaWikiServices::getBotPasswordStore ( )

Since: 1.37

Definition at line 895 of file MediaWikiServices.php.

◆ getCentralIdLookup()

MediaWiki\MediaWikiServices::getCentralIdLookup ( )

Since: 1.37

Definition at line 902 of file MediaWikiServices.php.

◆ getCentralIdLookupFactory()

MediaWiki\MediaWikiServices::getCentralIdLookupFactory ( )

Since: 1.37

Definition at line 909 of file MediaWikiServices.php.

◆ getChangesListQueryFactory()

MediaWiki\MediaWikiServices::getChangesListQueryFactory ( )

Since: 1.45

Returns: ChangesListQueryFactory

Definition at line 917 of file MediaWikiServices.php.

◆ getChangeTagDefStore()

MediaWiki\MediaWikiServices::getChangeTagDefStore ( )

Since: 1.32

Definition at line 924 of file MediaWikiServices.php.

◆ getChangeTagsStore()

MediaWiki\MediaWikiServices::getChangeTagsStore ( )

Since: 1.41

Definition at line 931 of file MediaWikiServices.php.

◆ getChangeTagsStoreFactory()

MediaWiki\MediaWikiServices::getChangeTagsStoreFactory ( )

Since: 1.46

Definition at line 938 of file MediaWikiServices.php.

◆ getChronologyProtector()

MediaWiki\MediaWikiServices::getChronologyProtector ( )

Since: 1.41

Definition at line 945 of file MediaWikiServices.php.

◆ getCollationFactory()

MediaWiki\MediaWikiServices::getCollationFactory ( )

Since: 1.37

Definition at line 952 of file MediaWikiServices.php.

◆ getCommentFormatter()

MediaWiki\MediaWikiServices::getCommentFormatter ( )

Since: 1.38

Definition at line 959 of file MediaWikiServices.php.

◆ getCommentParserFactory()

MediaWiki\MediaWikiServices::getCommentParserFactory ( )

Since: 1.41

Definition at line 966 of file MediaWikiServices.php.

◆ getCommentStore()

MediaWiki\MediaWikiServices::getCommentStore ( )

Since: 1.31

Definition at line 973 of file MediaWikiServices.php.

◆ getConfigFactory()

MediaWiki\MediaWikiServices::getConfigFactory ( )

Since: 1.27

Definition at line 980 of file MediaWikiServices.php.

◆ getConfigRepository()

MediaWiki\MediaWikiServices::getConfigRepository ( )

Deprecated: since 1.42. Unused.

Since: 1.32

Definition at line 988 of file MediaWikiServices.php.

◆ getConfigSchema()

MediaWiki\MediaWikiServices::getConfigSchema ( )

Since: 1.39

Definition at line 996 of file MediaWikiServices.php.

◆ getConfiguredReadOnlyMode()

MediaWiki\MediaWikiServices::getConfiguredReadOnlyMode ( )

Since: 1.29

Deprecated: since 1.41, use ::getReadOnlyMode() service together with ::getConfiguredReason() and ::isConfiguredReadOnly() to check when a site is set to read-only mode.

Hard deprecated in 1.45.

Definition at line 1020 of file MediaWikiServices.php.

◆ getConfirmEmailBuilderFactory()

MediaWiki\MediaWikiServices::getConfirmEmailBuilderFactory ( )

Definition at line 1000 of file MediaWikiServices.php.

◆ getConfirmEmailSender()

MediaWiki\MediaWikiServices::getConfirmEmailSender ( )

Definition at line 1004 of file MediaWikiServices.php.

◆ getConnectionProvider()

MediaWiki\MediaWikiServices::getConnectionProvider ( )

Since: 1.42

Definition at line 1028 of file MediaWikiServices.php.

◆ getContentHandlerFactory()

MediaWiki\MediaWikiServices::getContentHandlerFactory ( )

Since: 1.35

Definition at line 1035 of file MediaWikiServices.php.

◆ getContentJsonCodec()

MediaWiki\MediaWikiServices::getContentJsonCodec ( )

Since: 1.45

Definition at line 1042 of file MediaWikiServices.php.

◆ getContentLanguage()

MediaWiki\MediaWikiServices::getContentLanguage ( )

Since: 1.32

Definition at line 1049 of file MediaWikiServices.php.

◆ getContentLanguageCode()

MediaWiki\MediaWikiServices::getContentLanguageCode ( )

Since: 1.43

Definition at line 1056 of file MediaWikiServices.php.

◆ getContentModelChangeFactory()

MediaWiki\MediaWikiServices::getContentModelChangeFactory ( )

Since: 1.35

Definition at line 1063 of file MediaWikiServices.php.

◆ getContentModelStore()

MediaWiki\MediaWikiServices::getContentModelStore ( )

Since: 1.31

Definition at line 1070 of file MediaWikiServices.php.

◆ getContentRenderer()

MediaWiki\MediaWikiServices::getContentRenderer ( )

Since: 1.38

Definition at line 1077 of file MediaWikiServices.php.

Referenced by MediaWiki\EditPage\EditPage\doPreviewParse().

◆ getContentTransformer()

MediaWiki\MediaWikiServices::getContentTransformer ( )

Since: 1.37

Definition at line 1084 of file MediaWikiServices.php.

Referenced by MediaWiki\EditPage\EditPage\doPreviewParse(), and MediaWiki\EditPage\EditPage\showDiff().

◆ getCriticalSectionProvider()

MediaWiki\MediaWikiServices::getCriticalSectionProvider ( )

Since: 1.36

Definition at line 1091 of file MediaWikiServices.php.

◆ getCrossWikiBlockTargetFactory()

MediaWiki\MediaWikiServices::getCrossWikiBlockTargetFactory ( )

Since: 1.44

Definition at line 1098 of file MediaWikiServices.php.

◆ getDatabaseBlockStore()

MediaWiki\MediaWikiServices::getDatabaseBlockStore ( )

Since: 1.36

Definition at line 1105 of file MediaWikiServices.php.

◆ getDatabaseBlockStoreFactory()

MediaWiki\MediaWikiServices::getDatabaseBlockStoreFactory ( )

Since: 1.40

Definition at line 1112 of file MediaWikiServices.php.

◆ getDatabaseFactory()

MediaWiki\MediaWikiServices::getDatabaseFactory ( )

Since: 1.39

Definition at line 1119 of file MediaWikiServices.php.

◆ getDateFormatterFactory()

MediaWiki\MediaWikiServices::getDateFormatterFactory ( )

Since: 1.33

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

◆ getDBLoadBalancerFactory()

MediaWiki\MediaWikiServices::getDBLoadBalancerFactory ( )

Since: 1.28

Note: When possible, use getConnectionProvider() instead.

Definition at line 1142 of file MediaWikiServices.php.

◆ getDBLoadBalancerFactoryConfigBuilder()

MediaWiki\MediaWikiServices::getDBLoadBalancerFactoryConfigBuilder ( )

Since: 1.39

Definition at line 1149 of file MediaWikiServices.php.

◆ getDefaultOutputPipeline()

MediaWiki\MediaWikiServices::getDefaultOutputPipeline ( )

Returns: OutputTransformPipeline

Access: internal

Definition at line 1157 of file MediaWikiServices.php.

◆ getDeletePageFactory()

MediaWiki\MediaWikiServices::getDeletePageFactory ( )

Since: 1.37

Definition at line 1164 of file MediaWikiServices.php.

◆ getDomainEventDispatcher()

MediaWiki\MediaWikiServices::getDomainEventDispatcher ( )

Since: 1.44

Stability: unstable: until 1.45

Definition at line 1172 of file MediaWikiServices.php.

◆ getDomainEventSource()

MediaWiki\MediaWikiServices::getDomainEventSource ( )

Since: 1.44

Stability: unstable: until 1.45

Definition at line 1180 of file MediaWikiServices.php.

◆ getEmailer()

MediaWiki\MediaWikiServices::getEmailer ( )

Since: 1.35

Definition at line 1187 of file MediaWikiServices.php.

◆ getEmailUserFactory()

MediaWiki\MediaWikiServices::getEmailUserFactory ( )

Since: 1.41

Definition at line 1194 of file MediaWikiServices.php.

◆ getEventRelayerGroup()

MediaWiki\MediaWikiServices::getEventRelayerGroup ( )

Since: 1.27

Definition at line 1201 of file MediaWikiServices.php.

◆ getExtensionRegistry()

MediaWiki\MediaWikiServices::getExtensionRegistry ( )

Since: 1.42

Definition at line 1208 of file MediaWikiServices.php.

◆ getExternalStoreAccess()

MediaWiki\MediaWikiServices::getExternalStoreAccess ( )

Since: 1.34

Definition at line 1215 of file MediaWikiServices.php.

◆ getExternalStoreFactory()

MediaWiki\MediaWikiServices::getExternalStoreFactory ( )

Since: 1.31

Definition at line 1222 of file MediaWikiServices.php.

◆ getFeatureShutdown()

MediaWiki\MediaWikiServices::getFeatureShutdown ( )

Since: 1.44

Returns: FeatureShutdown

Definition at line 1230 of file MediaWikiServices.php.

◆ getFileBackendGroup()

MediaWiki\MediaWikiServices::getFileBackendGroup ( )

Since: 1.35

Definition at line 1237 of file MediaWikiServices.php.

◆ getFormatterFactory()

MediaWiki\MediaWikiServices::getFormatterFactory ( )

Since: 1.41

Definition at line 1244 of file MediaWikiServices.php.

◆ getGenderCache()

MediaWiki\MediaWikiServices::getGenderCache ( )

Since: 1.28

Definition at line 1251 of file MediaWikiServices.php.

◆ getGlobalIdGenerator()

MediaWiki\MediaWikiServices::getGlobalIdGenerator ( )

Since: 1.35

Definition at line 1258 of file MediaWikiServices.php.

◆ getGrantsInfo()

MediaWiki\MediaWikiServices::getGrantsInfo ( )

Since: 1.38

Definition at line 1265 of file MediaWikiServices.php.

◆ getGrantsLocalization()

MediaWiki\MediaWikiServices::getGrantsLocalization ( )

Since: 1.38

Definition at line 1272 of file MediaWikiServices.php.

◆ getGroupPermissionsLookup()

MediaWiki\MediaWikiServices::getGroupPermissionsLookup ( )

Since: 1.36

Definition at line 1279 of file MediaWikiServices.php.

◆ getHideUserUtils()

MediaWiki\MediaWikiServices::getHideUserUtils ( )

Since: 1.42

Returns: HideUserUtils

Definition at line 1287 of file MediaWikiServices.php.

◆ getHookContainer()

MediaWiki\MediaWikiServices::getHookContainer ( )

Since: 1.35

Definition at line 1294 of file MediaWikiServices.php.

Referenced by MediaWiki\EditPage\EditPage\getCopyrightWarning().

◆ getHtmlCacheUpdater()

MediaWiki\MediaWikiServices::getHtmlCacheUpdater ( )

Since: 1.35

Definition at line 1301 of file MediaWikiServices.php.

◆ getHtmlTransformFactory()

MediaWiki\MediaWikiServices::getHtmlTransformFactory ( )

Since: 1.39

Definition at line 1308 of file MediaWikiServices.php.

◆ getHttpRequestFactory()

MediaWiki\MediaWikiServices::getHttpRequestFactory ( )

Since: 1.31

Definition at line 1315 of file MediaWikiServices.php.

◆ getInstance()

static MediaWiki\MediaWikiServices::getInstance ( )

static

Returns the global default instance of the top level service locator.

Note: if called before allowGlobalInstance(), this method will fail.

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!

Definition at line 348 of file MediaWikiServices.php.

References wfDeprecatedMsg().

◆ getInterwikiLookup()

MediaWiki\MediaWikiServices::getInterwikiLookup ( )

Since: 1.28

Definition at line 1322 of file MediaWikiServices.php.

◆ getIntroMessageBuilder()

MediaWiki\MediaWikiServices::getIntroMessageBuilder ( )

Since: 1.41

Definition at line 1329 of file MediaWikiServices.php.

◆ getJobFactory()

MediaWiki\MediaWikiServices::getJobFactory ( )

Since: 1.40

Definition at line 1336 of file MediaWikiServices.php.

◆ getJobQueueGroup()

MediaWiki\MediaWikiServices::getJobQueueGroup ( )

Since: 1.37

Definition at line 1343 of file MediaWikiServices.php.

◆ getJobQueueGroupFactory()

MediaWiki\MediaWikiServices::getJobQueueGroupFactory ( )

Since: 1.37

Definition at line 1350 of file MediaWikiServices.php.

◆ getJobRunner()

MediaWiki\MediaWikiServices::getJobRunner ( )

Since: 1.35

Definition at line 1357 of file MediaWikiServices.php.

◆ getJsonCodec()

MediaWiki\MediaWikiServices::getJsonCodec ( )

Since: 1.36

Definition at line 1364 of file MediaWikiServices.php.

◆ getJwtCodec()

MediaWiki\MediaWikiServices::getJwtCodec ( )

Since: 1.45

Definition at line 1371 of file MediaWikiServices.php.

◆ getLanguageConverterFactory()

MediaWiki\MediaWikiServices::getLanguageConverterFactory ( )

Since: 1.35

Definition at line 1378 of file MediaWikiServices.php.

◆ getLanguageFactory()

MediaWiki\MediaWikiServices::getLanguageFactory ( )

Since: 1.35

Definition at line 1385 of file MediaWikiServices.php.

◆ getLanguageFallback()

MediaWiki\MediaWikiServices::getLanguageFallback ( )

Since: 1.35

Definition at line 1392 of file MediaWikiServices.php.

◆ getLanguageNameSearch()

MediaWiki\MediaWikiServices::getLanguageNameSearch ( )

Since: 1.46

Definition at line 1406 of file MediaWikiServices.php.

◆ getLanguageNameUtils()

MediaWiki\MediaWikiServices::getLanguageNameUtils ( )

Since: 1.34

Definition at line 1399 of file MediaWikiServices.php.

◆ getLeximorphFactory()

MediaWiki\MediaWikiServices::getLeximorphFactory ( )

Since: 1.45

Definition at line 1411 of file MediaWikiServices.php.

◆ getLinkBatchFactory()

MediaWiki\MediaWikiServices::getLinkBatchFactory ( )

Since: 1.35

Definition at line 1418 of file MediaWikiServices.php.

◆ getLinkCache()

MediaWiki\MediaWikiServices::getLinkCache ( )

Since: 1.28

Definition at line 1425 of file MediaWikiServices.php.

◆ getLinkRenderer()

MediaWiki\MediaWikiServices::getLinkRenderer ( )

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

Since: 1.28

Definition at line 1435 of file MediaWikiServices.php.

◆ getLinkRendererFactory()

MediaWiki\MediaWikiServices::getLinkRendererFactory ( )

Since: 1.28

Definition at line 1442 of file MediaWikiServices.php.

◆ getLinksMigration()

MediaWiki\MediaWikiServices::getLinksMigration ( )

Since: 1.39

Definition at line 1449 of file MediaWikiServices.php.

◆ getLinkTargetLookup()

MediaWiki\MediaWikiServices::getLinkTargetLookup ( )

Since: 1.38

Definition at line 1456 of file MediaWikiServices.php.

◆ getLinkWriteDuplicator()

MediaWiki\MediaWikiServices::getLinkWriteDuplicator ( )

Since: 1.46

Definition at line 1463 of file MediaWikiServices.php.

◆ getLintErrorChecker()

MediaWiki\MediaWikiServices::getLintErrorChecker ( )

Since: 1.43

Definition at line 1470 of file MediaWikiServices.php.

◆ getLocalisationCache()

MediaWiki\MediaWikiServices::getLocalisationCache ( )

Since: 1.34

Definition at line 1477 of file MediaWikiServices.php.

◆ getLocalServerObjectCache()

MediaWiki\MediaWikiServices::getLocalServerObjectCache ( )

Returns the main server-local cache, yielding EmptyBagOStuff if there is none.

In web request mode, the cache should at least be shared among web workers. In CLI mode, the cache should at least be shared among processes run by the same user.

Since: 1.28

Definition at line 1489 of file MediaWikiServices.php.

◆ getLockManagerGroupFactory()

MediaWiki\MediaWikiServices::getLockManagerGroupFactory ( )

Since: 1.34

Definition at line 1496 of file MediaWikiServices.php.

◆ getLogFormatterFactory()

MediaWiki\MediaWikiServices::getLogFormatterFactory ( )

Since: 1.42

Definition at line 1503 of file MediaWikiServices.php.

◆ getMagicWordFactory()

MediaWiki\MediaWikiServices::getMagicWordFactory ( )

Since: 1.32

Definition at line 1510 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

Definition at line 1520 of file MediaWikiServices.php.

Referenced by MediaWiki\EditPage\EditPage\getCopyrightWarning().

◆ getMainObjectStash()

MediaWiki\MediaWikiServices::getMainObjectStash ( )

Returns the main object stash, yielding EmptyBagOStuff if there is none.

The stash should be shared among all datacenters

Since: 1.28

Definition at line 1531 of file MediaWikiServices.php.

◆ getMainWANObjectCache()

MediaWiki\MediaWikiServices::getMainWANObjectCache ( )

Returns the main WAN cache, yielding EmptyBagOStuff if there is none.

The cache should relay any purge operations to all datacenters

Since: 1.28

Definition at line 1542 of file MediaWikiServices.php.

◆ getMediaHandlerFactory()

MediaWiki\MediaWikiServices::getMediaHandlerFactory ( )

Since: 1.28

Definition at line 1549 of file MediaWikiServices.php.

◆ getMergeHistoryFactory()

MediaWiki\MediaWikiServices::getMergeHistoryFactory ( )

Since: 1.35

Definition at line 1556 of file MediaWikiServices.php.

◆ getMessageCache()

MediaWiki\MediaWikiServices::getMessageCache ( )

Since: 1.34

Definition at line 1563 of file MediaWikiServices.php.

◆ getMessageFormatterFactory()

MediaWiki\MediaWikiServices::getMessageFormatterFactory ( )

Since: 1.34

Definition at line 1570 of file MediaWikiServices.php.

◆ getMessageParser()

MediaWiki\MediaWikiServices::getMessageParser ( )

Since: 1.44

Definition at line 1577 of file MediaWikiServices.php.

◆ getMicroStash()

MediaWiki\MediaWikiServices::getMicroStash ( )

Since: 1.42

Stability: unstable

Returns: BagOStuff

Definition at line 1586 of file MediaWikiServices.php.

◆ getMimeAnalyzer()

MediaWiki\MediaWikiServices::getMimeAnalyzer ( )

Since: 1.28

Definition at line 1593 of file MediaWikiServices.php.

◆ getMovePageFactory()

MediaWiki\MediaWikiServices::getMovePageFactory ( )

Since: 1.34

Definition at line 1600 of file MediaWikiServices.php.

◆ getMultiFormatUserIdentityLookup()

MediaWiki\MediaWikiServices::getMultiFormatUserIdentityLookup ( )

Definition at line 1604 of file MediaWikiServices.php.

◆ getNamespaceInfo()

MediaWiki\MediaWikiServices::getNamespaceInfo ( )

Since: 1.34

Definition at line 1611 of file MediaWikiServices.php.

◆ getNameTableStoreFactory()

MediaWiki\MediaWikiServices::getNameTableStoreFactory ( )

Since: 1.32

Definition at line 1618 of file MediaWikiServices.php.

◆ getNotificationEmailSender()

MediaWiki\MediaWikiServices::getNotificationEmailSender ( )

Definition at line 1008 of file MediaWikiServices.php.

◆ getNotificationService()

MediaWiki\MediaWikiServices::getNotificationService ( )

Since: 1.45

Definition at line 1625 of file MediaWikiServices.php.

◆ getObjectCacheFactory()

MediaWiki\MediaWikiServices::getObjectCacheFactory ( )

Since: 1.42

Returns: ObjectCacheFactory

Definition at line 1633 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

Definition at line 1643 of file MediaWikiServices.php.

◆ getOldRevisionImporter()

MediaWiki\MediaWikiServices::getOldRevisionImporter ( )

Since: 1.32

Definition at line 1650 of file MediaWikiServices.php.

◆ getPageEditStash()

MediaWiki\MediaWikiServices::getPageEditStash ( )

Since: 1.34

Definition at line 1657 of file MediaWikiServices.php.

◆ getPageProps()

MediaWiki\MediaWikiServices::getPageProps ( )

Since: 1.36

Definition at line 1664 of file MediaWikiServices.php.

◆ getPageRestHelperFactory()

MediaWiki\MediaWikiServices::getPageRestHelperFactory ( )

Since: 1.40

Definition at line 1671 of file MediaWikiServices.php.

◆ getPageStore()

MediaWiki\MediaWikiServices::getPageStore ( )

Since: 1.36

Definition at line 1678 of file MediaWikiServices.php.

◆ getPageStoreFactory()

MediaWiki\MediaWikiServices::getPageStoreFactory ( )

Since: 1.36

Definition at line 1685 of file MediaWikiServices.php.

◆ getPageUpdaterFactory()

MediaWiki\MediaWikiServices::getPageUpdaterFactory ( )

Since: 1.37

Definition at line 1692 of file MediaWikiServices.php.

◆ getParser()

MediaWiki\MediaWikiServices::getParser ( )

Get the main Parser instance.

This is unsafe when the caller is not in a top-level context, because re-entering the parser will throw an exception.

Note: Do not use this service for dependency injection or in service wiring. It is convenience function to get the global instance in global code. For dependency injection or service wiring code use the parser factory via the 'ParserFactory' service and call one of the factory functions, preferably ParserFactory::create.

Since: 1.29

Definition at line 1709 of file MediaWikiServices.php.

◆ getParserCache()

MediaWiki\MediaWikiServices::getParserCache ( )

Since: 1.30

Definition at line 1716 of file MediaWikiServices.php.

◆ getParserCacheFactory()

MediaWiki\MediaWikiServices::getParserCacheFactory ( )

Since: 1.36

Definition at line 1723 of file MediaWikiServices.php.

◆ getParserFactory()

MediaWiki\MediaWikiServices::getParserFactory ( )

Since: 1.32

Definition at line 1730 of file MediaWikiServices.php.

◆ getParserOutputAccess()

MediaWiki\MediaWikiServices::getParserOutputAccess ( )

Since: 1.36

Definition at line 1737 of file MediaWikiServices.php.

◆ getParsoidDataAccess()

MediaWiki\MediaWikiServices::getParsoidDataAccess ( )

Since: 1.39

Access: internal

Definition at line 1745 of file MediaWikiServices.php.

◆ getParsoidOutputStash()

MediaWiki\MediaWikiServices::getParsoidOutputStash ( )

Since: 1.39

Stability: unstable: since 1.39, should be stable before release of 1.39

Definition at line 1753 of file MediaWikiServices.php.

◆ getParsoidPageConfigFactory()

MediaWiki\MediaWikiServices::getParsoidPageConfigFactory ( )

Since: 1.39

Access: internal

Definition at line 1761 of file MediaWikiServices.php.

◆ getParsoidParserFactory()

MediaWiki\MediaWikiServices::getParsoidParserFactory ( )

Since: 1.41

Access: internal

Definition at line 1769 of file MediaWikiServices.php.

◆ getParsoidSiteConfig()

MediaWiki\MediaWikiServices::getParsoidSiteConfig ( )

Since: 1.39

Access: internal

Definition at line 1777 of file MediaWikiServices.php.

◆ getPasswordFactory()

MediaWiki\MediaWikiServices::getPasswordFactory ( )

Since: 1.32

Definition at line 1784 of file MediaWikiServices.php.

◆ getPasswordReset()

MediaWiki\MediaWikiServices::getPasswordReset ( )

Since: 1.34

Definition at line 1791 of file MediaWikiServices.php.

◆ getPatrolManager()

MediaWiki\MediaWikiServices::getPatrolManager ( )

Since: 1.45

Definition at line 1798 of file MediaWikiServices.php.

◆ getPerDbNameStatsdDataFactory()

MediaWiki\MediaWikiServices::getPerDbNameStatsdDataFactory ( )

Since: 1.32

Deprecated: since 1.44 Use StatsFactory with setLabel() instead

For example:

$statsFactory
     ->getCounter( 'example_total' )
     ->setLabel( 'wiki', WikiMap::getCurrentWikiId() )

Definition at line 1814 of file MediaWikiServices.php.

◆ getPermissionManager()

MediaWiki\MediaWikiServices::getPermissionManager ( )

Since: 1.33

Definition at line 1821 of file MediaWikiServices.php.

◆ getPingback()

MediaWiki\MediaWikiServices::getPingback ( )

Since: 1.41

Access: internal

Definition at line 1829 of file MediaWikiServices.php.

◆ getPoolCounterFactory()

MediaWiki\MediaWikiServices::getPoolCounterFactory ( )

Since: 1.40

Definition at line 1836 of file MediaWikiServices.php.

◆ getPreferencesFactory()

MediaWiki\MediaWikiServices::getPreferencesFactory ( )

Since: 1.31

Definition at line 1843 of file MediaWikiServices.php.

◆ getPreloadedContentBuilder()

MediaWiki\MediaWikiServices::getPreloadedContentBuilder ( )

Since: 1.41

Definition at line 1850 of file MediaWikiServices.php.

◆ getProxyLookup()

MediaWiki\MediaWikiServices::getProxyLookup ( )

Since: 1.28

Definition at line 1857 of file MediaWikiServices.php.

◆ getRateLimiter()

MediaWiki\MediaWikiServices::getRateLimiter ( )

Since: 1.39

Definition at line 1864 of file MediaWikiServices.php.

◆ getReadOnlyMode()

MediaWiki\MediaWikiServices::getReadOnlyMode ( )

Since: 1.29

Definition at line 1871 of file MediaWikiServices.php.

◆ getRecentChangeFactory()

MediaWiki\MediaWikiServices::getRecentChangeFactory ( )

Since: 1.45

Definition at line 1878 of file MediaWikiServices.php.

◆ getRecentChangeLookup()

MediaWiki\MediaWikiServices::getRecentChangeLookup ( )

Since: 1.45

Definition at line 1885 of file MediaWikiServices.php.

◆ getRecentChangeRCFeedNotifier()

MediaWiki\MediaWikiServices::getRecentChangeRCFeedNotifier ( )

Since: 1.45

Definition at line 1892 of file MediaWikiServices.php.

◆ getRecentChangeStore()

MediaWiki\MediaWikiServices::getRecentChangeStore ( )

Since: 1.45

Definition at line 1899 of file MediaWikiServices.php.

◆ getRedirectLookup()

MediaWiki\MediaWikiServices::getRedirectLookup ( )

Since: 1.38

Definition at line 1906 of file MediaWikiServices.php.

◆ getRedirectStore()

MediaWiki\MediaWikiServices::getRedirectStore ( )

Since: 1.38

Definition at line 1913 of file MediaWikiServices.php.

◆ getRenameUserFactory()

MediaWiki\MediaWikiServices::getRenameUserFactory ( )

Since: 1.44

Definition at line 1920 of file MediaWikiServices.php.

◆ getRepoGroup()

MediaWiki\MediaWikiServices::getRepoGroup ( )

Since: 1.34

Definition at line 1927 of file MediaWikiServices.php.

◆ getResourceLoader()

MediaWiki\MediaWikiServices::getResourceLoader ( )

Since: 1.33

Definition at line 1934 of file MediaWikiServices.php.

◆ getRestrictedUserGroupCheckerFactory()

MediaWiki\MediaWikiServices::getRestrictedUserGroupCheckerFactory ( )

Since: 1.46

Definition at line 1941 of file MediaWikiServices.php.

◆ getRestrictedUserGroupConfigReader()

MediaWiki\MediaWikiServices::getRestrictedUserGroupConfigReader ( )

Since: 1.46

Definition at line 1948 of file MediaWikiServices.php.

◆ getRestrictionStore()

MediaWiki\MediaWikiServices::getRestrictionStore ( )

Since: 1.37

Definition at line 1955 of file MediaWikiServices.php.

◆ getRevertedTagUpdateManager()

MediaWiki\MediaWikiServices::getRevertedTagUpdateManager ( )

Since: 1.36

Definition at line 1962 of file MediaWikiServices.php.

◆ getRevisionFactory()

MediaWiki\MediaWikiServices::getRevisionFactory ( )

Since: 1.31

Definition at line 1969 of file MediaWikiServices.php.

◆ getRevisionLookup()

MediaWiki\MediaWikiServices::getRevisionLookup ( )

Since: 1.31

Definition at line 1976 of file MediaWikiServices.php.

◆ getRevisionRenderer()

MediaWiki\MediaWikiServices::getRevisionRenderer ( )

Since: 1.32

Definition at line 1983 of file MediaWikiServices.php.

◆ getRevisionStore()

MediaWiki\MediaWikiServices::getRevisionStore ( )

Since: 1.31

Definition at line 1990 of file MediaWikiServices.php.

◆ getRevisionStoreFactory()

MediaWiki\MediaWikiServices::getRevisionStoreFactory ( )

Since: 1.32

Definition at line 1997 of file MediaWikiServices.php.

◆ getRollbackPageFactory()

MediaWiki\MediaWikiServices::getRollbackPageFactory ( )

Since: 1.37

Definition at line 2004 of file MediaWikiServices.php.

◆ getRowCommentFormatter()

MediaWiki\MediaWikiServices::getRowCommentFormatter ( )

Since: 1.38

Definition at line 2011 of file MediaWikiServices.php.

◆ getSearchEngineConfig()

MediaWiki\MediaWikiServices::getSearchEngineConfig ( )

Since: 1.27

Definition at line 2026 of file MediaWikiServices.php.

◆ getSearchEngineFactory()

MediaWiki\MediaWikiServices::getSearchEngineFactory ( )

Since: 1.27

Definition at line 2033 of file MediaWikiServices.php.

◆ getSearchResultThumbnailProvider()

MediaWiki\MediaWikiServices::getSearchResultThumbnailProvider ( )

Since: 1.40

Definition at line 2040 of file MediaWikiServices.php.

◆ getService()

MediaWiki\MediaWikiServices::getService ( $name )

Definition at line 375 of file MediaWikiServices.php.

References wfDeprecatedMsg().

◆ getSessionManager()

MediaWiki\MediaWikiServices::getSessionManager ( )

Since: 1.44

Definition at line 2047 of file MediaWikiServices.php.

◆ getSessionStore()

MediaWiki\MediaWikiServices::getSessionStore ( )

Since: 1.45

Definition at line 2054 of file MediaWikiServices.php.

◆ getShellboxClientFactory()

MediaWiki\MediaWikiServices::getShellboxClientFactory ( )

Since: 1.36

Definition at line 2061 of file MediaWikiServices.php.

◆ getShellCommandFactory()

MediaWiki\MediaWikiServices::getShellCommandFactory ( )

Since: 1.30

Definition at line 2068 of file MediaWikiServices.php.

◆ getSignatureValidatorFactory()

MediaWiki\MediaWikiServices::getSignatureValidatorFactory ( )

Since: 1.38

Definition at line 2075 of file MediaWikiServices.php.

◆ getSiteLookup()

MediaWiki\MediaWikiServices::getSiteLookup ( )

Since: 1.27

Definition at line 2082 of file MediaWikiServices.php.

◆ getSiteStore()

MediaWiki\MediaWikiServices::getSiteStore ( )

Since: 1.27

Definition at line 2089 of file MediaWikiServices.php.

◆ getSkinFactory()

MediaWiki\MediaWikiServices::getSkinFactory ( )

Since: 1.27

Definition at line 2096 of file MediaWikiServices.php.

◆ getSlotRoleRegistry()

MediaWiki\MediaWikiServices::getSlotRoleRegistry ( )

Since: 1.33

Definition at line 2103 of file MediaWikiServices.php.

◆ getSlotRoleStore()

MediaWiki\MediaWikiServices::getSlotRoleStore ( )

Since: 1.31

Definition at line 2110 of file MediaWikiServices.php.

◆ getSpamChecker()

MediaWiki\MediaWikiServices::getSpamChecker ( )

Since: 1.35

Definition at line 2117 of file MediaWikiServices.php.

◆ getSpecialPageFactory()

MediaWiki\MediaWikiServices::getSpecialPageFactory ( )

Since: 1.32

Definition at line 2124 of file MediaWikiServices.php.

◆ getStatsdDataFactory()

MediaWiki\MediaWikiServices::getStatsdDataFactory ( )

Since: 1.27

Definition at line 2131 of file MediaWikiServices.php.

◆ getStatsFactory()

MediaWiki\MediaWikiServices::getStatsFactory ( )

Since: 1.41

Definition at line 2138 of file MediaWikiServices.php.

◆ getTalkPageNotificationManager()

MediaWiki\MediaWikiServices::getTalkPageNotificationManager ( )

Since: 1.35

Definition at line 2145 of file MediaWikiServices.php.

◆ getTempFSFileFactory()

MediaWiki\MediaWikiServices::getTempFSFileFactory ( )

Since: 1.34

Definition at line 2152 of file MediaWikiServices.php.

◆ getTempUserConfig()

MediaWiki\MediaWikiServices::getTempUserConfig ( )

Since: 1.39

Definition at line 2159 of file MediaWikiServices.php.

◆ getTempUserCreator()

MediaWiki\MediaWikiServices::getTempUserCreator ( )

Since: 1.39

Definition at line 2166 of file MediaWikiServices.php.

◆ getTempUserDetailsLookup()

MediaWiki\MediaWikiServices::getTempUserDetailsLookup ( )

Since: 1.44

Definition at line 2173 of file MediaWikiServices.php.

◆ getTidy()

MediaWiki\MediaWikiServices::getTidy ( )

Since: 1.36

Definition at line 2180 of file MediaWikiServices.php.

◆ getTitleFactory()

MediaWiki\MediaWikiServices::getTitleFactory ( )

Since: 1.35

Definition at line 2187 of file MediaWikiServices.php.

◆ getTitleFormatter()

MediaWiki\MediaWikiServices::getTitleFormatter ( )

Since: 1.28

Definition at line 2194 of file MediaWikiServices.php.

◆ getTitleMatcher()

MediaWiki\MediaWikiServices::getTitleMatcher ( )

Since: 1.40

Definition at line 2201 of file MediaWikiServices.php.

◆ getTitleParser()

MediaWiki\MediaWikiServices::getTitleParser ( )

Since: 1.28

Definition at line 2208 of file MediaWikiServices.php.

◆ getTracer()

MediaWiki\MediaWikiServices::getTracer ( )

Definition at line 2212 of file MediaWikiServices.php.

◆ getTrackingCategories()

MediaWiki\MediaWikiServices::getTrackingCategories ( )

Since: 1.38

Definition at line 2219 of file MediaWikiServices.php.

◆ getUnblockUserFactory()

MediaWiki\MediaWikiServices::getUnblockUserFactory ( )

Since: 1.36

Definition at line 2226 of file MediaWikiServices.php.

◆ getUndeletePageFactory()

MediaWiki\MediaWikiServices::getUndeletePageFactory ( )

Since: 1.38

Definition at line 2233 of file MediaWikiServices.php.

◆ getUploadRevisionImporter()

MediaWiki\MediaWikiServices::getUploadRevisionImporter ( )

Since: 1.32

Definition at line 2240 of file MediaWikiServices.php.

◆ getUploadVerification()

MediaWiki\MediaWikiServices::getUploadVerification ( )

Since: 1.45

Definition at line 2247 of file MediaWikiServices.php.

◆ getUrlUtils()

MediaWiki\MediaWikiServices::getUrlUtils ( )

Since: 1.39

Definition at line 2254 of file MediaWikiServices.php.

◆ getUserCache()

MediaWiki\MediaWikiServices::getUserCache ( )

Since: 1.36

Deprecated: since 1.43, use ActorStore

Definition at line 2262 of file MediaWikiServices.php.

◆ getUserEditTracker()

MediaWiki\MediaWikiServices::getUserEditTracker ( )

Since: 1.35

Definition at line 2269 of file MediaWikiServices.php.

◆ getUserFactory()

MediaWiki\MediaWikiServices::getUserFactory ( )

Since: 1.35

Definition at line 2276 of file MediaWikiServices.php.

◆ getUserGroupAssignmentService()

MediaWiki\MediaWikiServices::getUserGroupAssignmentService ( )

Since: 1.45

Definition at line 2283 of file MediaWikiServices.php.

◆ getUserGroupManager()

MediaWiki\MediaWikiServices::getUserGroupManager ( )

Since: 1.35

Definition at line 2290 of file MediaWikiServices.php.

◆ getUserGroupManagerFactory()

MediaWiki\MediaWikiServices::getUserGroupManagerFactory ( )

Since: 1.35

Definition at line 2297 of file MediaWikiServices.php.

◆ getUserIdentityLookup()

MediaWiki\MediaWikiServices::getUserIdentityLookup ( )

Since: 1.36

Definition at line 2304 of file MediaWikiServices.php.

◆ getUserIdentityUtils()

MediaWiki\MediaWikiServices::getUserIdentityUtils ( )

Since: 1.41

Definition at line 2311 of file MediaWikiServices.php.

◆ getUserLinkRenderer()

MediaWiki\MediaWikiServices::getUserLinkRenderer ( )

Since: 1.44

Access: internal

Definition at line 2319 of file MediaWikiServices.php.

◆ getUserNamePrefixSearch()

MediaWiki\MediaWikiServices::getUserNamePrefixSearch ( )

Since: 1.36

Definition at line 2326 of file MediaWikiServices.php.

◆ getUserNameUtils()

MediaWiki\MediaWikiServices::getUserNameUtils ( )

Since: 1.35

Definition at line 2333 of file MediaWikiServices.php.

◆ getUserOptionsLookup()

MediaWiki\MediaWikiServices::getUserOptionsLookup ( )

Since: 1.35

Definition at line 2340 of file MediaWikiServices.php.

◆ getUserOptionsManager()

MediaWiki\MediaWikiServices::getUserOptionsManager ( )

Since: 1.35

Definition at line 2347 of file MediaWikiServices.php.

◆ getUserRegistrationLookup()

MediaWiki\MediaWikiServices::getUserRegistrationLookup ( )

Since: 1.41

Definition at line 2354 of file MediaWikiServices.php.

◆ getUserRequirementsConditionChecker()

MediaWiki\MediaWikiServices::getUserRequirementsConditionChecker ( )

Since: 1.45

Definition at line 2361 of file MediaWikiServices.php.

◆ getUserRequirementsConditionCheckerFactory()

MediaWiki\MediaWikiServices::getUserRequirementsConditionCheckerFactory ( )

Since: 1.45

Definition at line 2368 of file MediaWikiServices.php.

◆ getWatchedItemQueryService()

MediaWiki\MediaWikiServices::getWatchedItemQueryService ( )

Since: 1.28

Definition at line 2375 of file MediaWikiServices.php.

◆ getWatchedItemStore()

MediaWiki\MediaWikiServices::getWatchedItemStore ( )

Since: 1.28

Definition at line 2382 of file MediaWikiServices.php.

◆ getWatchlistLabelStore()

MediaWiki\MediaWikiServices::getWatchlistLabelStore ( )

Since: 1.46

Definition at line 2389 of file MediaWikiServices.php.

◆ getWatchlistManager()

MediaWiki\MediaWikiServices::getWatchlistManager ( )

Since: 1.36

Definition at line 2396 of file MediaWikiServices.php.

◆ getWikiExporterFactory()

MediaWiki\MediaWikiServices::getWikiExporterFactory ( )

Since: 1.38

Definition at line 2403 of file MediaWikiServices.php.

◆ getWikiImporterFactory()

MediaWiki\MediaWikiServices::getWikiImporterFactory ( )

Since: 1.37

Definition at line 2410 of file MediaWikiServices.php.

◆ getWikiPageFactory()

MediaWiki\MediaWikiServices::getWikiPageFactory ( )

Since: 1.36

Definition at line 2417 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporter()

MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporter ( )

Since: 1.31

Definition at line 2424 of file MediaWikiServices.php.

◆ getWikiRevisionOldRevisionImporterNoUpdates()

MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporterNoUpdates ( )

Since: 1.31

Definition at line 2431 of file MediaWikiServices.php.

◆ getWikiRevisionUploadImporter()

MediaWiki\MediaWikiServices::getWikiRevisionUploadImporter ( )

Since: 1.31

Definition at line 2438 of file MediaWikiServices.php.

◆ getWRStatsFactory()

MediaWiki\MediaWikiServices::getWRStatsFactory ( )

Since: 1.39

Definition at line 2445 of file MediaWikiServices.php.

◆ hasInstance()

static MediaWiki\MediaWikiServices::hasInstance ( )

static

Returns true if an instance has already been initialized and can be obtained from getInstance().

This can be used to avoid accessing services if it's not safe or un necessary, e.g. in certain cases in unit tests or during early setup.

Definition at line 327 of file MediaWikiServices.php.

Referenced by MediaWiki\Html\TemplateParser\getTemplate().

◆ isStorageDisabled()

MediaWiki\MediaWikiServices::isStorageDisabled ( )

Returns true if disableStorage() has been called on this MediaWikiServices instance.

Definition at line 614 of file MediaWikiServices.php.

◆ newSearchEngine()

MediaWiki\MediaWikiServices::newSearchEngine ( )

Since: 1.27

Definition at line 2018 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(); disableStorage()

Definition at line 630 of file MediaWikiServices.php.

Referenced by MediaWiki\Maintenance\ForkController\prepareEnvironment().

◆ resetGlobalInstance()

static MediaWiki\MediaWikiServices::resetGlobalInstance	(	?Config	$bootstrapConfig = null,
			$mode = 'reset' )

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. The method must not be 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).; 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	$mode	May be one of: quick: allow expensive resources to be re-used. See SalvageableService for details. reset: discard expensive resources but reuse service wiring (default) reload: discard expensive resources and reload the service wiring

Definition at line 444 of file MediaWikiServices.php.

References $runner.

Referenced by MediaWiki\Installer\Installer\disableStorage().

◆ 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.

Definition at line 659 of file MediaWikiServices.php.

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

includes/MediaWikiServices.php

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowGlobalInstance()

◆ allowGlobalInstanceAfterUnitTests()

◆ disableStorage()

◆ disableStorageBackend()

◆ disallowGlobalInstanceInUnitTests()

◆ failIfResetNotAllowed()

◆ forceGlobalInstance()

◆ getActionFactory()

◆ getActorMigration()

◆ getActorNormalization()

◆ getActorStore()

◆ getActorStoreFactory()

◆ getArchivedRevisionLookup()

◆ getAuthManager()

◆ getAutoblockExemptionList()

◆ getBacklinkCacheFactory()

◆ getBadFileLookup()

◆ getBlobStore()

◆ getBlobStoreFactory()

◆ getBlockActionInfo()

◆ getBlockErrorFormatter()

◆ getBlockManager()

◆ getBlockPermissionCheckerFactory()

◆ getBlockRestrictionStore()

◆ getBlockRestrictionStoreFactory()

◆ getBlockTargetFactory()

◆ getBlockUserFactory()

◆ getBlockUtils()

◆ getBlockUtilsFactory()

◆ getBootstrapConfig()

◆ getBotPasswordStore()

◆ getCentralIdLookup()

◆ getCentralIdLookupFactory()

◆ getChangesListQueryFactory()

◆ getChangeTagDefStore()

◆ getChangeTagsStore()

◆ getChangeTagsStoreFactory()

◆ getChronologyProtector()

◆ getCollationFactory()

◆ getCommentFormatter()

◆ getCommentParserFactory()

◆ getCommentStore()

◆ getConfigFactory()

◆ getConfigRepository()

◆ getConfigSchema()

◆ getConfiguredReadOnlyMode()

◆ getConfirmEmailBuilderFactory()

◆ getConfirmEmailSender()

◆ getConnectionProvider()

◆ getContentHandlerFactory()

◆ getContentJsonCodec()

◆ getContentLanguage()

◆ getContentLanguageCode()

◆ getContentModelChangeFactory()

◆ getContentModelStore()

◆ getContentRenderer()

◆ getContentTransformer()

◆ getCriticalSectionProvider()

◆ getCrossWikiBlockTargetFactory()

◆ getDatabaseBlockStore()

◆ getDatabaseBlockStoreFactory()

◆ getDatabaseFactory()

◆ getDateFormatterFactory()

◆ getDBLoadBalancer()

◆ getDBLoadBalancerFactory()

◆ getDBLoadBalancerFactoryConfigBuilder()

◆ getDefaultOutputPipeline()

◆ getDeletePageFactory()

◆ getDomainEventDispatcher()

◆ getDomainEventSource()

◆ getEmailer()

◆ getEmailUserFactory()

◆ getEventRelayerGroup()

◆ getExtensionRegistry()