MediaWiki
1.34.4
|
MediaWikiServices is the service locator for the application scope of MediaWiki. More...
Static Public Member Functions | |
static | disableStorageBackend () |
Disables all storage layer services. More... | |
static | failIfResetNotAllowed ( $method) |
Convenience method that throws an exception unless it is called during a phase in which resetting of global services is allowed. More... | |
static | forceGlobalInstance (MediaWikiServices $services) |
Replaces the global MediaWikiServices instance. More... | |
static | getInstance () |
Returns the global default instance of the top level service locator. More... | |
static | resetChildProcessServices () |
Resets any services that may have become stale after a child process returns from after pcntl_fork(). More... | |
static | resetGlobalInstance (Config $bootstrapConfig=null, $quick='') |
Creates a new instance of MediaWikiServices and sets it as the global default instance. More... | |
Private Member Functions | |
salvage (self $other) | |
@noinspection PhpDocSignatureInspection More... | |
Static Private Member Functions | |
static | newInstance (Config $bootstrapConfig, $loadWiring='') |
Creates a new MediaWikiServices instance and initializes it according to the given $bootstrapConfig. More... | |
Static Private Attributes | |
static MediaWikiServices null | $instance = null |
Additional Inherited Members | |
Protected Member Functions inherited from Wikimedia\Services\ServiceContainer | |
resetService ( $name, $destroy=true) | |
Resets a service by dropping the service instance. More... | |
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().
Definition at line 117 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::__construct | ( | Config | $config | ) |
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 419 of file MediaWikiServices.php.
|
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.
Definition at line 313 of file MediaWikiServices.php.
References ObjectCache\clear().
|
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.
This method will throw an exception if:
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.
string | $method | the name of the caller method, as given by METHOD. |
MWException | if called outside bootstrap mode. |
Definition at line 403 of file MediaWikiServices.php.
|
static |
Replaces the global MediaWikiServices instance.
MWException | if called outside of PHPUnit tests. |
MediaWikiServices | $services | The new MediaWikiServices object. |
Definition at line 164 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::getActorMigration | ( | ) |
MediaWiki\MediaWikiServices::getBadFileLookup | ( | ) |
MediaWiki\MediaWikiServices::getBlobStore | ( | ) |
MediaWiki\MediaWikiServices::getBlobStoreFactory | ( | ) |
MediaWiki\MediaWikiServices::getBlockManager | ( | ) |
MediaWiki\MediaWikiServices::getBlockRestrictionStore | ( | ) |
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.
Definition at line 491 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::getChangeTagDefStore | ( | ) |
MediaWiki\MediaWikiServices::getCommentStore | ( | ) |
MediaWiki\MediaWikiServices::getConfigFactory | ( | ) |
MediaWiki\MediaWikiServices::getConfigRepository | ( | ) |
MediaWiki\MediaWikiServices::getConfiguredReadOnlyMode | ( | ) |
MediaWiki\MediaWikiServices::getContentLanguage | ( | ) |
MediaWiki\MediaWikiServices::getContentModelStore | ( | ) |
MediaWiki\MediaWikiServices::getCryptHKDF | ( | ) |
MediaWiki\MediaWikiServices::getDateFormatterFactory | ( | ) |
MediaWiki\MediaWikiServices::getDBLoadBalancer | ( | ) |
Definition at line 571 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::getDBLoadBalancerFactory | ( | ) |
MediaWiki\MediaWikiServices::getEventRelayerGroup | ( | ) |
MediaWiki\MediaWikiServices::getExternalStoreAccess | ( | ) |
MediaWiki\MediaWikiServices::getExternalStoreFactory | ( | ) |
MediaWiki\MediaWikiServices::getGenderCache | ( | ) |
MediaWiki\MediaWikiServices::getHttpRequestFactory | ( | ) |
|
static |
Returns the global default instance of the top level service locator.
The default instance is initialized using the service instantiator functions defined in ServiceWiring.php.
Definition at line 138 of file MediaWikiServices.php.
Referenced by MediaWiki\Extension\OATHAuth\Special\DisableOATHForUser\__construct(), MediaWiki\Auth\Throttler\__construct(), MediaWiki\Extension\OATHAuth\Special\OATHManage\__construct(), MediaWiki\Session\SessionManager\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Extension\OATHAuth\Auth\SecondaryAuthenticationProvider\beginSecondaryAuthentication(), MediaWiki\Extension\OATHAuth\Auth\TOTPSecondaryAuthenticationProvider\beginSecondaryAuthentication(), MediaWiki\Extension\OATHAuth\Hook\TwoFactorIsEnabled\SetIsEnabled\callback(), MediaWiki\Extension\OATHAuth\Hook\GetPreferences\AuthModule\callback(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), File\checkExtensionCompatibility(), MediaWiki\Preferences\DefaultPreferencesFactory\cleanSignature(), MediaWiki\Block\DatabaseBlock\clearCookie(), MediaWiki\Shell\Shell\command(), StreamFile\contentTypeFromPath(), MediaWiki\Extension\OATHAuth\Auth\SecondaryAuthenticationProvider\continueSecondaryAuthentication(), MediaWiki\Extension\OATHAuth\Auth\TOTPSecondaryAuthenticationProvider\continueSecondaryAuthentication(), MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\convertToGenericFields(), DeleteAutoPatrolLogs\deleteRows(), PopulateChangeTagDef\doDBUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), MediaWiki\Extension\OATHAuth\Api\Module\ApiOATHValidate\execute(), SpecialNewFiles\execute(), MediaWiki\Extension\OATHAuth\Api\Module\ApiQueryOATH\execute(), RunBatchedQuery\execute(), ImageBuilder\execute(), RebuildFileCache\finalSetup(), MediaWiki\Widget\Search\FullSearchResultWidget\generateFileHtml(), ApiQuerySearch\getAllowedParams(), MediaWiki\Block\DatabaseBlock\getBlockRestrictionStore(), MediaWiki\Block\DatabaseBlock\getBlocksForIPList(), MediaWiki\Block\DatabaseBlock\getCookieValue(), UploadStash\getExtensionForPath(), SpecialMediaStatistics\getExtensionList(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), MediaWiki\Block\DatabaseBlock\getIdFromCookieValue(), ForeignAPIFile\getMediaType(), UnregisteredLocalFile\getMimeType(), ForeignAPIFile\getMimeType(), DeleteAutoPatrolLogs\getRows(), DeleteAutoPatrolLogs\getRowsOld(), MediaWiki\EditPage\TextboxBuilder\getTextboxProtectionCSSClasses(), MediaHandler\getThumbType(), PdfHandler\getThumbType(), DjVuHandler\getThumbType(), UploadBase\getTitle(), FileBackendGroup\guessMimeInternal(), ChannelFeed\httpHeaders(), MediaWiki\Extensions\ParserFunctions\ParserFunctions\ifexistInternal(), CreatePdfThumbnailsJob\insertJobs(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), MediaWiki\Rest\EntryPoint\main(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), MediaWiki\parseTitle(), MediaWiki\performRequest(), MediaWiki\Widget\Search\SearchFormWidget\powerSearchBox(), MediaWiki\preOutputCommit(), MediaWiki\Storage\DerivedPageDataUpdater\prepareContent(), MediaWiki\Block\AbstractBlock\prevents(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Block\DatabaseBlock\purgeExpired(), MediaWiki\Widget\Search\FullSearchResultWidget\render(), MediaWiki\Widget\Search\BasicSearchResultSetWidget\render(), MediaWiki\restInPeace(), PageImages\Job\InitImageDataJob\run(), MediaWiki\Linker\LinkRenderer\runLegacyBeginHook(), MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateOldUsersFromInstaller(), MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateSubstituteForGenericFields(), MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateTOTPToMultipleKeys(), MediaWiki\Block\DatabaseBlock\setCookie(), MediaWiki\setDBProfilingAgent(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Widget\Search\SearchFormWidget\startsWithImage(), MediaWiki\triggerAsyncJobs(), MediaWiki\tryNormaliseRedirect(), Revision\RevisionRecord\userCanBitfield(), MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature(), MediaWiki\Extension\OATHAuth\Key\TOTPKey\verify(), UploadBase\verifyExtension(), and UploadBase\verifyMimeType().
MediaWiki\MediaWikiServices::getInterwikiLookup | ( | ) |
MediaWiki\MediaWikiServices::getLanguageNameUtils | ( | ) |
MediaWiki\MediaWikiServices::getLinkCache | ( | ) |
MediaWiki\MediaWikiServices::getLinkRenderer | ( | ) |
LinkRenderer instance that can be used if no custom options are needed.
Definition at line 654 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::getLinkRendererFactory | ( | ) |
MediaWiki\MediaWikiServices::getLocalisationCache | ( | ) |
MediaWiki\MediaWikiServices::getLocalServerObjectCache | ( | ) |
MediaWiki\MediaWikiServices::getLockManagerGroupFactory | ( | ) |
MediaWiki\MediaWikiServices::getMagicWordFactory | ( | ) |
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().
Definition at line 705 of file MediaWikiServices.php.
Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().
MediaWiki\MediaWikiServices::getMainObjectStash | ( | ) |
MediaWiki\MediaWikiServices::getMainWANObjectCache | ( | ) |
MediaWiki\MediaWikiServices::getMediaHandlerFactory | ( | ) |
MediaWiki\MediaWikiServices::getMessageCache | ( | ) |
MediaWiki\MediaWikiServices::getMessageFormatterFactory | ( | ) |
Definition at line 745 of file MediaWikiServices.php.
Referenced by MediaWiki\Rest\EntryPoint\getTextFormatters().
MediaWiki\MediaWikiServices::getMimeAnalyzer | ( | ) |
MediaWiki\MediaWikiServices::getMovePageFactory | ( | ) |
MediaWiki\MediaWikiServices::getNamespaceInfo | ( | ) |
MediaWiki\MediaWikiServices::getNameTableStoreFactory | ( | ) |
MediaWiki\MediaWikiServices::getObjectFactory | ( | ) |
ObjectFactory is intended for instantiating "handlers" from declarative definitions, such as Action API modules, special pages, or REST API handlers.
Definition at line 788 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::getOldRevisionImporter | ( | ) |
MediaWiki\MediaWikiServices::getPageEditStash | ( | ) |
MediaWiki\MediaWikiServices::getParser | ( | ) |
MediaWiki\MediaWikiServices::getParserCache | ( | ) |
MediaWiki\MediaWikiServices::getParserFactory | ( | ) |
MediaWiki\MediaWikiServices::getPasswordFactory | ( | ) |
MediaWiki\MediaWikiServices::getPasswordReset | ( | ) |
MediaWiki\MediaWikiServices::getPerDbNameStatsdDataFactory | ( | ) |
MediaWiki\MediaWikiServices::getPermissionManager | ( | ) |
MediaWiki\MediaWikiServices::getPreferencesFactory | ( | ) |
MediaWiki\MediaWikiServices::getProxyLookup | ( | ) |
MediaWiki\MediaWikiServices::getReadOnlyMode | ( | ) |
MediaWiki\MediaWikiServices::getRepoGroup | ( | ) |
MediaWiki\MediaWikiServices::getResourceLoader | ( | ) |
MediaWiki\MediaWikiServices::getRevisionFactory | ( | ) |
MediaWiki\MediaWikiServices::getRevisionLookup | ( | ) |
MediaWiki\MediaWikiServices::getRevisionRenderer | ( | ) |
MediaWiki\MediaWikiServices::getRevisionStore | ( | ) |
MediaWiki\MediaWikiServices::getRevisionStoreFactory | ( | ) |
MediaWiki\MediaWikiServices::getSearchEngineConfig | ( | ) |
MediaWiki\MediaWikiServices::getSearchEngineFactory | ( | ) |
MediaWiki\MediaWikiServices::getShellCommandFactory | ( | ) |
MediaWiki\MediaWikiServices::getSiteLookup | ( | ) |
MediaWiki\MediaWikiServices::getSiteStore | ( | ) |
MediaWiki\MediaWikiServices::getSkinFactory | ( | ) |
MediaWiki\MediaWikiServices::getSlotRoleRegistry | ( | ) |
MediaWiki\MediaWikiServices::getSlotRoleStore | ( | ) |
MediaWiki\MediaWikiServices::getSpecialPageFactory | ( | ) |
MediaWiki\MediaWikiServices::getStatsdDataFactory | ( | ) |
MediaWiki\MediaWikiServices::getTempFSFileFactory | ( | ) |
MediaWiki\MediaWikiServices::getTitleFormatter | ( | ) |
MediaWiki\MediaWikiServices::getTitleParser | ( | ) |
MediaWiki\MediaWikiServices::getUploadRevisionImporter | ( | ) |
MediaWiki\MediaWikiServices::getVirtualRESTServiceClient | ( | ) |
MediaWiki\MediaWikiServices::getWatchedItemQueryService | ( | ) |
MediaWiki\MediaWikiServices::getWatchedItemStore | ( | ) |
MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporter | ( | ) |
MediaWiki\MediaWikiServices::getWikiRevisionOldRevisionImporterNoUpdates | ( | ) |
MediaWiki\MediaWikiServices::getWikiRevisionUploadImporter | ( | ) |
|
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.
Config | null | $bootstrapConfig | The Config object to be registered as the 'BootstrapConfig' service. |
string | $loadWiring | set this to 'load' to load the wiring files specified in the 'ServiceWiringFiles' setting in $bootstrapConfig. |
MWException | |
Definition at line 283 of file MediaWikiServices.php.
References Config\get(), and Hooks\run().
MediaWiki\MediaWikiServices::newSearchEngine | ( | ) |
|
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.
Definition at line 337 of file MediaWikiServices.php.
|
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().
Config | null | $bootstrapConfig | The Config object to be registered as the 'BootstrapConfig' service. This has to contain at least the information needed to set up the 'ConfigFactory' service. If not given, the bootstrap config of the old instance of MediaWikiServices will be re-used. If there was no previous instance, a new GlobalVarConfig object will be used to bootstrap the services. |
string | $quick | Set this to "quick" to allow expensive resources to be re-used. See SalvageableService for details. |
MWException | If called after MW_SERVICE_BOOTSTRAP_COMPLETE has been defined in Setup.php (unless MW_PHPUNIT_TEST or MEDIAWIKI_INSTALL or RUN_MAINTENANCE_IF_MAIN is defined). |
Definition at line 214 of file MediaWikiServices.php.
MediaWiki\MediaWikiServices::resetServiceForTesting | ( | $name, | |
$destroy = true |
|||
) |
Resets the given service for testing purposes.
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. |
MWException | if called outside of PHPUnit tests. |
Definition at line 368 of file MediaWikiServices.php.
|
private |
@noinspection PhpDocSignatureInspection
Salvages the state of any salvageable service instances in $other.
MediaWikiServices | $other |
Definition at line 247 of file MediaWikiServices.php.
|
staticprivate |
Definition at line 122 of file MediaWikiServices.php.