Go to the documentation of this file.
51 use Wikimedia\ObjectFactory;
58 $mainConfig->get(
'LBFactoryConf' ),
64 $instance =
new $class( $lbConf );
72 return $services->getDBLoadBalancerFactory()->getMainLB();
86 $cacheFile =
$services->getMainConfig()->get(
'SitesCacheFile' );
88 if ( $cacheFile !==
false ) {
98 $registry =
$services->getBootstrapConfig()->get(
'ConfigRegistry' );
101 foreach ( $registry
as $name => $callback ) {
102 $factory->register(
$name, $callback );
109 return $services->getConfigFactory()->makeConfig(
'main' );
118 $config->get(
'InterwikiExpiry' ),
119 $config->get(
'InterwikiCache' ),
120 $config->get(
'InterwikiScopes' ),
121 $config->get(
'InterwikiFallbackSite' )
127 rtrim(
$services->getMainConfig()->get(
'StatsdMetricPrefix' ),
'.' )
147 $names =
$services->getMainConfig()->get(
'ValidSkinNames' );
151 $class =
"Skin$skin";
152 return new $class(
$name );
156 $factory->register(
'fallback',
'Fallback',
function () {
160 $factory->register(
'apioutput',
'ApiOutput',
function () {
172 $services->getMainConfig()->get(
'UpdateRowsPerQuery' )
174 $store->setStatsdDataFactory(
$services->getStatsdDataFactory() );
176 if (
$services->getMainConfig()->get(
'ReadOnlyWatchedItemStore' ) ) {
192 $secretKey =
$services->getMainConfig()->get(
'SecretKey' );
202 function ()
use ( $secretKey ) {
203 return $secretKey ?:
'';
211 defined(
'MW_CONFIG_FILE' ) ? [ MW_CONFIG_FILE ] : [],
212 LoggerFactory::getInstance(
'CryptRand' )
219 $secret = $config->get(
'HKDFSecret' ) ?: $config->get(
'SecretKey' );
221 throw new RuntimeException(
"Cannot use MWCryptHKDF without a secret." );
226 $context = [ microtime(), getmypid(), gethostname() ];
234 return new CryptHKDF( $secret, $config->get(
'HKDFAlgorithm' ),
241 $services->getMainConfig()->get(
'MediaHandlers' )
246 $logger = LoggerFactory::getInstance(
'Mime' );
247 $mainConfig =
$services->getMainConfig();
249 'typeFile' => $mainConfig->get(
'MimeTypeFile' ),
250 'infoFile' => $mainConfig->get(
'MimeInfoFile' ),
251 'xmlTypes' => $mainConfig->get(
'XMLMimeTypes' ),
253 function ( $mimeAnalyzer, &$head, &$tail, $file, &
$mime )
use ( $logger ) {
256 if ( $deja->isValid() ) {
257 $logger->info( __METHOD__ .
": detected $file as image/vnd.djvu\n" );
258 $mime =
'image/vnd.djvu';
264 'MimeMagicGuessFromContent',
265 [ $mimeAnalyzer, &$head, &$tail, $file, &
$mime ]
268 'extCallback' =>
function ( $mimeAnalyzer,
$ext, &
$mime ) {
272 'initCallback' =>
function ( $mimeAnalyzer ) {
274 Hooks::run(
'MimeMagicInit', [ $mimeAnalyzer ] );
279 if (
$params[
'infoFile'] ===
'includes/mime.info' ) {
280 $params[
'infoFile'] = __DIR__ .
"/libs/mime/mime.info";
283 if (
$params[
'typeFile'] ===
'includes/mime.types' ) {
284 $params[
'typeFile'] = __DIR__ .
"/libs/mime/mime.types";
287 $detectorCmd = $mainConfig->get(
'MimeDetectorCommand' );
288 if ( $detectorCmd ) {
289 $factory =
$services->getShellCommandFactory();
290 $params[
'detectCallback'] =
function ( $file )
use ( $detectorCmd, $factory ) {
293 ->unsafeParams( $detectorCmd )
305 $mainConfig =
$services->getMainConfig();
307 $mainConfig->get(
'SquidServers' ),
308 $mainConfig->get(
'SquidServersNoPurge' )
313 $conf =
$services->getMainConfig()->get(
'ParserConf' );
314 return ObjectFactory::constructClassInstance( $conf[
'class'], [ $conf ] );
324 $config->get(
'CacheEpoch' )
345 if ( defined(
'MW_NO_SESSION' ) ) {
346 return $services->getLinkRendererFactory()->create();
362 $services->getMainConfig()->get(
'LocalInterwikis' )
367 return $services->getService(
'_MediaWikiTitleCodec' );
371 return $services->getService(
'_MediaWikiTitleCodec' );
375 $mainConfig =
$services->getMainConfig();
377 $id = $mainConfig->get(
'MainStash' );
378 if ( !isset( $mainConfig->get(
'ObjectCaches' )[$id] ) ) {
379 throw new UnexpectedValueException(
380 "Cache type \"$id\" is not present in \$wgObjectCaches." );
383 return \ObjectCache::newFromParams( $mainConfig->get(
'ObjectCaches' )[$id] );
387 $mainConfig =
$services->getMainConfig();
389 $id = $mainConfig->get(
'MainWANCache' );
390 if ( !isset( $mainConfig->get(
'WANObjectCaches' )[$id] ) ) {
391 throw new UnexpectedValueException(
392 "WAN cache type \"$id\" is not present in \$wgWANObjectCaches." );
395 $params = $mainConfig->get(
'WANObjectCaches' )[$id];
396 $objectCacheId =
$params[
'cacheId'];
397 if ( !isset( $mainConfig->get(
'ObjectCaches' )[$objectCacheId] ) ) {
398 throw new UnexpectedValueException(
399 "Cache type \"$objectCacheId\" is not present in \$wgObjectCaches." );
401 $params[
'store'] = $mainConfig->get(
'ObjectCaches' )[$objectCacheId];
403 return \ObjectCache::newWANCacheFromParams(
$params );
407 $mainConfig =
$services->getMainConfig();
409 if ( function_exists(
'apc_fetch' ) ) {
411 } elseif ( function_exists(
'apcu_fetch' ) ) {
413 } elseif ( function_exists(
'wincache_ucache_get' ) ) {
419 if ( !isset( $mainConfig->get(
'ObjectCaches' )[$id] ) ) {
420 throw new UnexpectedValueException(
421 "Cache type \"$id\" is not present in \$wgObjectCaches." );
424 return \ObjectCache::newFromParams( $mainConfig->get(
'ObjectCaches' )[$id] );
428 $config =
$services->getMainConfig()->get(
'VirtualRestConfig' );
431 foreach ( $config[
'paths']
as $prefix => $serviceConfig ) {
432 $class = $serviceConfig[
'class'];
434 $constructArg = isset( $serviceConfig[
'options'] )
435 ? $serviceConfig[
'options']
437 $constructArg += $config[
'global'];
439 $vrsClient->mount( $prefix, [
'class' => $class,
'config' => $constructArg ] );
458 $services->getMainConfig()->get(
'EnableUploads' ),
459 LoggerFactory::getInstance(
'UploadRevisionImporter' )
466 LoggerFactory::getInstance(
'OldRevisionImporter' ),
474 LoggerFactory::getInstance(
'OldRevisionImporter' ),
483 'time' => $config->get(
'MaxShellTime' ),
484 'walltime' => $config->get(
'MaxShellWallClockTime' ),
485 'memory' => $config->get(
'MaxShellMemory' ),
486 'filesize' => $config->get(
'MaxShellFileSize' ),
488 $cgroup = $config->get(
'ShellCgroup' );
489 $restrictionMethod = $config->get(
'ShellRestrictionMethod' );
491 $factory =
new CommandFactory( $limits, $cgroup, $restrictionMethod );
492 $factory->setLogger( LoggerFactory::getInstance(
'exec' ) );
493 $factory->logStderr();
502 $config->get(
'ExternalStores' )
508 $blobStore =
$services->getService(
'_SqlBlobStore' );
518 $store->setLogger( LoggerFactory::getInstance(
'RevisionStore' ) );
521 $store->setContentHandlerUseDB( $config->get(
'ContentHandlerUseDB' ) );
545 return $services->getService(
'_SqlBlobStore' );
549 return $services->getBlobStoreFactory()->newSqlBlobStore();
556 LoggerFactory::getInstance(
'NameTableSqlStore' ),
573 LoggerFactory::getInstance(
'NameTableSqlStore' ),
583 $authManager = AuthManager::singleton();
587 $factory->setLogger( LoggerFactory::getInstance(
'preferences' ) );
593 return new \MediaWiki\Http\HttpRequestFactory();
600 $services->getMainConfig()->get(
'CommentTableSchemaMigrationStage' )
606 $services->getMainConfig()->get(
'ActorTableSchemaMigrationStage' )
Factory class for spawning EventRelayer objects using configuration.
Cache for article titles (prefixed DB keys) and ids linked from one source.
Class to handle concurrent HTTP requests.
Provides a file-based cache of a SiteStore.
static getLocalClusterInstance()
Get the main cluster-local cache object.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
SkinTemplate class for API output.
Simple store for keeping values in an associative array for the current process.
A BagOStuff object with no objects in it.
A service class for fetching the wiki's current read-only mode.
Caches user genders when needed to use correct namespace aliases.
Support for detecting/validating DjVu image files and getting some basic file metadata (resolution et...
Factory class for SearchEngine.
This class handles the logic for the actor table migration.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Virtual HTTP service client loosely styled after a Virtual File System.
SkinTemplate class for the fallback skin.
static getInstance( $id)
Get a cached instance of the specified type of cache object.
A factory for application metric data.
static getLBFactoryClass(array $config)
Returns the LBFactory class to use and the load balancer configuration.
static applyDefaultConfig(array $lbConf, Config $mainConfig, ConfiguredReadOnlyMode $readOnlyMode)
wfGetCache( $cacheType)
Get a specific cache object.
when a variable name is used in a it is silently declared as a new masking the global
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
if( $ext=='php'|| $ext=='php5') $mime
static setSchemaAliases(LBFactory $lbFactory, Config $config)
Factory class to create Skin objects.
Storage layer class for WatchedItems.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Allows to change the fields on the form that will be generated $name
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Factory class to create Config objects.
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Configuration handling class for SearchEngine.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
wfIsHHVM()
Check if we are running under HHVM.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang