Go to the documentation of this file.
130 'envCheckModSecurity',
136 'envCheckShellLocale',
137 'envCheckUploadsDirectory',
139 'envCheckSuhosinMaxValueLength',
171 'wgEmailAuthentication',
175 'wgImageMagickConvertCommand',
180 'wgDeletedDirectory',
184 'wgUseInstantCommons',
199 '_Environment' =>
false,
200 '_RaiseMemory' =>
false,
201 '_UpgradeDone' =>
false,
202 '_InstallDone' =>
false,
204 '_InstallPassword' =>
'',
205 '_SameAccount' =>
true,
206 '_CreateDBAccount' =>
false,
207 '_NamespaceType' =>
'site-name',
209 '_AdminPassword' =>
'',
210 '_AdminPasswordConfirm' =>
'',
212 '_Subscribe' =>
false,
213 '_SkipOptional' =>
'continue',
214 '_RightsProfile' =>
'wiki',
215 '_LicenseCode' =>
'none',
219 '_MemCachedServers' =>
'',
220 '_UpgradeKeySupplied' =>
false,
221 '_ExistingDBSettings' =>
false,
225 'wgLogo' =>
'$wgResourceBasePath/resources/assets/wiki.png',
226 'wgAuthenticationTokenVersion' => 1,
249 'apc' =>
'apc_fetch',
250 'apcu' =>
'apcu_fetch',
251 'wincache' =>
'wincache_ucache_get'
262 '*' => [
'edit' =>
false ]
266 'createaccount' =>
false,
272 'createaccount' =>
false,
286 'url' =>
'https://creativecommons.org/licenses/by/4.0/',
287 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by.png',
290 'url' =>
'https://creativecommons.org/licenses/by-sa/4.0/',
291 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
294 'url' =>
'https://creativecommons.org/licenses/by-nc-sa/4.0/',
295 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
298 'url' =>
'https://creativecommons.org/publicdomain/zero/1.0/',
299 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/cc-0.png',
302 'url' =>
'https://www.gnu.org/copyleft/fdl.html',
303 'icon' =>
'$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
322 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
328 'ca',
'cs',
'da',
'de',
'en',
'es',
'et',
'eu',
'fi',
'fr',
'hr',
'hu',
329 'it',
'ja',
'ko',
'lt',
'nl',
'no',
'pl',
'pt',
'pt-br',
'ro',
'ru',
330 'sl',
'sr',
'sv',
'tr',
'uk'
346 abstract public function showError( $msg );
376 ] + $baseConfig->
get(
'ObjectCaches' );
381 $messageDirs = $baseConfig->
get(
'MessagesDirs' );
382 $messageDirs[
'MediawikiInstaller'] = __DIR__ .
'/i18n';
384 $configOverrides->set(
'MessagesDirs', $messageDirs );
386 $installerConfig =
new MultiConfig( [ $configOverrides, $baseConfig ] );
389 $configRegistry = $baseConfig->
get(
'ConfigRegistry' );
390 $configRegistry[
'main'] =
function ()
use ( $installerConfig ) {
391 return $installerConfig;
394 $configOverrides->set(
'ConfigRegistry', $configRegistry );
396 return $installerConfig;
409 MediaWikiServices::resetGlobalInstance( $installerConfig );
420 MediaWikiServices::disableStorageBackend();
422 $mwServices = MediaWikiServices::getInstance();
429 $mwServices->redefineService(
'InterwikiLookup',
function () {
439 foreach ( $this->defaultVarNames
as $var ) {
445 $this->compiledDBs = [];
446 foreach ( self::getDBTypes()
as $type ) {
449 if ( !$installer->isCompiled() ) {
452 $this->compiledDBs[] =
$type;
457 $this->parserOptions->setTidy(
true );
488 $this->
showMessage(
'config-env-hhvm', HHVM_VERSION );
490 $this->
showMessage(
'config-env-php', PHP_VERSION );
495 list( $pcreVersion ) = explode(
' ', PCRE_VERSION, 2 );
496 if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION,
'<' ) ) {
497 $this->
showError(
'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
500 foreach ( $this->envChecks
as $check ) {
508 $this->
setVar(
'_Environment', $good );
514 foreach ( $this->envPreps
as $prep ) {
564 return ucfirst(
$type ) .
'Installer';
581 if ( !isset( $this->dbInstallers[
$type] ) ) {
583 $this->dbInstallers[
$type] =
new $class( $this );
586 return $this->dbInstallers[
$type];
610 Wikimedia\suppressWarnings();
611 $_lsExists = file_exists(
"$IP/LocalSettings.php" );
612 Wikimedia\restoreWarnings();
619 require
"$IP/includes/DefaultSettings.php";
620 require
"$IP/LocalSettings.php";
622 return get_defined_vars();
635 return str_repeat(
'*', strlen( $realPassword ) );
646 if ( !preg_match(
'/^\*+$/',
$value ) ) {
663 if ( !function_exists(
'posix_getegid' ) || !function_exists(
'posix_getpwuid' ) ) {
664 # I don't know this, this isn't UNIX.
668 # posix_getegid() *not* getmygid() because we want the group of the webserver,
669 # not whoever owns the current script.
670 $gid = posix_getegid();
671 $group = posix_getpwuid( $gid )[
'name'];
692 public function parse( $text, $lineStart =
false ) {
696 $out =
$wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
698 'enableSectionEditLinks' =>
false,
702 }
catch (
MediaWiki\Services\ServiceDisabledException
$e ) {
703 $html =
'<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
717 $this->parserOptions->setExternalLinkTarget(
false );
742 'ss_total_edits' => 0,
743 'ss_good_articles' => 0,
744 'ss_total_pages' => 0,
746 'ss_active_users' => 0,
766 foreach ( self::getDBTypes()
as $name ) {
767 $allNames[] =
wfMessage(
"config-type-$name" )->text();
772 $databases = array_flip( $databases );
773 foreach ( array_keys( $databases )
as $db ) {
775 $status = $installer->checkPrerequisites();
780 unset( $databases[$db] );
783 $databases = array_flip( $databases );
785 $this->
showError(
'config-no-db', $wgLang->commaList( $allNames ),
count( $allNames ) );
801 $this->
showError(
'config-brokenlibxml' );
818 Wikimedia\suppressWarnings();
819 $regexd = preg_replace(
'/[\x{0430}-\x{04FF}]/iu',
'',
'-АБВГД-' );
824 $regexprop = preg_replace(
'/\p{Zs}/u',
'',
"-\u{3000}-" );
825 Wikimedia\restoreWarnings();
826 if ( $regexd !=
'--' || $regexprop !=
'--' ) {
827 $this->
showError(
'config-pcre-no-utf8' );
840 $limit = ini_get(
'memory_limit' );
842 if ( !$limit || $limit == -1 ) {
848 if ( $n < $this->minMemorySize * 1024 * 1024 ) {
849 $newLimit =
"{$this->minMemorySize}M";
851 if ( ini_set(
"memory_limit", $newLimit ) ===
false ) {
854 $this->
showMessage(
'config-memory-raised', $limit, $newLimit );
855 $this->
setVar(
'_RaiseMemory',
true );
867 foreach ( $this->objectCaches
as $name => $function ) {
868 if ( function_exists( $function ) ) {
869 $caches[
$name] =
true;
874 $key =
'config-no-cache-apcu';
878 $this->
setVar(
'_Caches', $caches );
886 if ( self::apacheModulePresent(
'mod_security' )
887 || self::apacheModulePresent(
'mod_security2' ) ) {
899 $names = [
"gdiff3",
"diff3" ];
901 $names[] =
'diff3.exe';
903 $versionInfo = [
'--version',
'GNU diffutils' ];
908 $this->
setVar(
'wgDiff3', $diff3 );
910 $this->
setVar(
'wgDiff3',
false );
922 $names =
wfIsWindows() ?
'convert.exe' :
'convert';
923 $versionInfo = [
'-version',
'ImageMagick' ];
926 $this->
setVar(
'wgImageMagickConvertCommand',
'' );
928 $this->
setVar(
'wgImageMagickConvertCommand', $convert );
929 $this->
showMessage(
'config-imagemagick', $convert );
932 } elseif ( function_exists(
'imagejpeg' ) ) {
949 $versionInfo = [
'--version',
'git version' ];
954 $this->
setVar(
'wgGitBin', $git );
957 $this->
setVar(
'wgGitBin',
false );
971 if ( $server !==
null ) {
972 $this->
showMessage(
'config-using-server', $server );
985 $this->
getVar(
'wgServer' ),
986 $this->
getVar(
'wgScriptPath' )
996 $os = php_uname(
's' );
997 $supported = [
'Linux',
'SunOS',
'HP-UX',
'Darwin' ]; # Tested these
999 if ( !in_array( $os, $supported ) ) {
1003 if ( Shell::isDisabled() ) {
1007 # Get a list of available locales.
1008 $result = Shell::command(
'/usr/bin/locale',
'-a' )
1011 if (
$result->getExitCode() != 0 ) {
1017 $candidatesByLocale = [];
1018 $candidatesByLang = [];
1020 if (
$line ===
'' ) {
1024 if ( !preg_match(
'/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i',
$line, $m ) ) {
1030 $candidatesByLocale[$m[0]] = $m;
1031 $candidatesByLang[
$lang][] = $m;
1034 # Try the current value of LANG.
1035 if ( isset( $candidatesByLocale[getenv(
'LANG' )] ) ) {
1036 $this->
setVar(
'wgShellLocale', getenv(
'LANG' ) );
1041 # Try the most common ones.
1042 $commonLocales = [
'C.UTF-8',
'en_US.UTF-8',
'en_US.utf8',
'de_DE.UTF-8',
'de_DE.utf8' ];
1043 foreach ( $commonLocales
as $commonLocale ) {
1044 if ( isset( $candidatesByLocale[$commonLocale] ) ) {
1045 $this->
setVar(
'wgShellLocale', $commonLocale );
1051 # Is there an available locale in the Wiki's language?
1052 $wikiLang = $this->
getVar(
'wgLanguageCode' );
1054 if ( isset( $candidatesByLang[$wikiLang] ) ) {
1055 $m = reset( $candidatesByLang[$wikiLang] );
1056 $this->
setVar(
'wgShellLocale', $m[0] );
1061 # Are there any at all?
1062 if (
count( $candidatesByLocale ) ) {
1063 $m = reset( $candidatesByLocale );
1064 $this->
setVar(
'wgShellLocale', $m[0] );
1080 $dir =
$IP .
'/images/';
1081 $url = $this->
getVar(
'wgServer' ) . $this->
getVar(
'wgScriptPath' ) .
'/images/';
1085 $this->
showMessage(
'config-uploads-not-safe', $dir );
1097 $maxValueLength = ini_get(
'suhosin.get.max_value_length' );
1098 if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
1100 $this->
showMessage(
'config-suhosin-max-value-length', $maxValueLength );
1113 if ( PHP_INT_SIZE == 4 ) {
1131 $not_normal_c =
"\u{FA6C}";
1132 $normal_c =
"\u{242EE}";
1134 $useNormalizer =
'php';
1135 $needsUpdate =
false;
1137 if ( function_exists(
'normalizer_normalize' ) ) {
1138 $useNormalizer =
'intl';
1139 $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
1140 if ( $intl !== $normal_c ) {
1141 $needsUpdate =
true;
1146 if ( $useNormalizer ===
'php' ) {
1147 $this->
showMessage(
'config-unicode-pure-php-warning' );
1149 $this->
showMessage(
'config-unicode-using-' . $useNormalizer );
1150 if ( $needsUpdate ) {
1151 $this->
showMessage(
'config-unicode-update-warning' );
1161 if ( $server !==
null ) {
1162 $this->
setVar(
'wgServer', $server );
1177 $IP = dirname( dirname( __DIR__ ) );
1178 $this->
setVar(
'IP', $IP );
1192 "<?php echo 'ex' . 'ec';",
1193 "#!/var/env php\n<?php echo 'ex' . 'ec';",
1199 Wikimedia\suppressWarnings();
1201 foreach ( $scriptTypes
as $ext => $contents ) {
1203 $file =
'exectest.' .
$ext;
1205 if ( !file_put_contents( $dir . $file,
$source ) ) {
1210 $text =
Http::get( $url . $file, [
'timeout' => 3 ], __METHOD__ );
1211 }
catch ( Exception
$e ) {
1215 unlink( $dir . $file );
1217 if ( $text ==
'exec' ) {
1218 Wikimedia\restoreWarnings();
1225 Wikimedia\restoreWarnings();
1237 if ( function_exists(
'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
1242 phpinfo( INFO_MODULES );
1243 $info = ob_get_clean();
1245 return strpos( $info, $moduleName ) !==
false;
1254 $this->parserOptions->setTargetLanguage(
$lang );
1255 $this->parserOptions->setUserLang(
$lang );
1264 return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1276 switch ( $directory ) {
1282 throw new InvalidArgumentException(
"Invalid extension type" );
1295 if ( $this->
getVar(
'IP' ) ===
null ) {
1299 $extDir = $this->
getVar(
'IP' ) .
'/' . $directory;
1300 if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
1304 $dh = opendir( $extDir );
1306 while ( ( $file = readdir( $dh ) ) !==
false ) {
1307 if ( !is_dir(
"$extDir/$file" ) ) {
1312 $exts[$file] =
$status->value;
1316 uksort( $exts,
'strnatcasecmp' );
1329 if ( $this->
getVar(
'IP' ) ===
null ) {
1330 throw new Exception(
'Cannot find extensions since the IP variable is not yet set' );
1332 if (
$type !==
'extension' &&
$type !==
'skin' ) {
1333 throw new InvalidArgumentException(
"Invalid extension type" );
1335 $absDir = $this->
getVar(
'IP' ) .
"/$parentRelPath/$name";
1336 $relDir =
"../$parentRelPath/$name";
1337 if ( !is_dir( $absDir ) ) {
1340 $jsonFile =
$type .
'.json';
1341 $fullJsonFile =
"$absDir/$jsonFile";
1342 $isJson = file_exists( $fullJsonFile );
1346 $fullPhpFile =
"$absDir/$name.php";
1347 $isPhp = file_exists( $fullPhpFile );
1349 if ( !$isJson && !$isPhp ) {
1355 if ( is_dir(
"$absDir/screenshots" ) ) {
1356 $paths = glob(
"$absDir/screenshots/*.png" );
1358 $info[
'screenshots'][] = str_replace( $absDir, $relDir,
$path );
1364 if ( !$jsonStatus->isOK() ) {
1367 $info += $jsonStatus->value;
1381 private function readExtension( $fullJsonFile, $extDeps = [], $skinDeps = [] ) {
1386 $extDir = $this->
getVar(
'IP' ) .
'/extensions';
1387 foreach ( $extDeps
as $dep ) {
1388 $fname =
"$extDir/$dep/extension.json";
1389 if ( !file_exists(
$fname ) ) {
1396 $skinDir = $this->
getVar(
'IP' ) .
'/skins';
1397 foreach ( $skinDeps
as $dep ) {
1398 $fname =
"$skinDir/$dep/skin.json";
1399 if ( !file_exists(
$fname ) ) {
1407 $info = $registry->readFromQueue( $load );
1409 if (
$e->incompatibleCore ||
$e->incompatibleSkins
1410 ||
$e->incompatibleExtensions
1415 basename( dirname( $fullJsonFile ) ),
$e->getMessage() );
1416 } elseif (
$e->missingExtensions ||
$e->missingSkins ) {
1421 array_merge( $extDeps,
$e->missingExtensions ),
1422 array_merge( $skinDeps,
$e->missingSkins )
1427 basename( dirname( $fullJsonFile ) ),
$e->getMessage() );
1434 foreach ( $info[
'credits']
as $name => $credit ) {
1440 $type = basename( $credit[
'path'] ) ===
'skin.json' ?
'skins' :
'extensions';
1441 $ret[
'requires'][
$type][] = $credit[
'name'];
1443 $credits = array_values( $info[
'credits'] )[0];
1444 if ( isset( $credits[
'url'] ) ) {
1445 $ret[
'url'] = $credits[
'url'];
1447 $ret[
'type'] = $credits[
'type'];
1461 $defaultSkin =
$GLOBALS[
'wgDefaultSkin'];
1462 if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
1463 return $defaultSkin;
1465 return $skinNames[0];
1476 $exts = $this->
getVar(
'_Extensions' );
1477 $IP = $this->
getVar(
'IP' );
1481 define(
'MW_EXTENSIONS_LOADED',
true );
1495 require
"$IP/includes/DefaultSettings.php";
1497 foreach ( $exts
as $e ) {
1498 if ( file_exists(
"$IP/extensions/$e/extension.json" ) ) {
1499 $queue[
"$IP/extensions/$e/extension.json"] = 1;
1501 require_once
"$IP/extensions/$e/$e.php";
1506 $data = $registry->readFromQueue(
$queue );
1509 $hooksWeWant = isset(
$wgHooks[
'LoadExtensionSchemaUpdates'] ) ?
1511 $wgHooks[
'LoadExtensionSchemaUpdates'] : [];
1513 if ( isset( $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates'] ) ) {
1514 $hooksWeWant = array_merge_recursive(
1516 $data[
'globals'][
'wgHooks'][
'LoadExtensionSchemaUpdates']
1521 $GLOBALS[
'wgHooks'] = [
'LoadExtensionSchemaUpdates' => $hooksWeWant ];
1539 $coreInstallSteps = [
1540 [
'name' =>
'database',
'callback' => [ $installer,
'setupDatabase' ] ],
1541 [
'name' =>
'tables',
'callback' => [ $installer,
'createTables' ] ],
1542 [
'name' =>
'interwiki',
'callback' => [ $installer,
'populateInterwikiTable' ] ],
1543 [
'name' =>
'stats',
'callback' => [ $this,
'populateSiteStats' ] ],
1544 [
'name' =>
'keys',
'callback' => [ $this,
'generateKeys' ] ],
1545 [
'name' =>
'updates',
'callback' => [ $installer,
'insertUpdateKeys' ] ],
1546 [
'name' =>
'sysop',
'callback' => [ $this,
'createSysop' ] ],
1547 [
'name' =>
'mainpage',
'callback' => [ $this,
'createMainpage' ] ],
1552 foreach ( $coreInstallSteps
as $step ) {
1553 $this->installSteps[] = $step;
1554 if ( isset( $this->extraInstallSteps[$step[
'name']] ) ) {
1555 $this->installSteps = array_merge(
1556 $this->installSteps,
1557 $this->extraInstallSteps[$step[
'name']]
1563 if ( isset( $this->extraInstallSteps[
'BEGINNING'] ) ) {
1564 $this->installSteps = array_merge(
1565 $this->extraInstallSteps[
'BEGINNING'],
1572 array_unshift( $this->installSteps,
1573 [
'name' =>
'extensions',
'callback' => [ $this,
'includeExtensions' ] ]
1575 $this->installSteps[] = [
1576 'name' =>
'extension-tables',
1577 'callback' => [ $installer,
'createExtensionTables' ]
1593 $installResults = [];
1595 $installer->preInstall();
1597 foreach ( $steps
as $stepObj ) {
1598 $name = $stepObj[
'name'];
1599 call_user_func_array( $startCB, [
$name ] );
1602 $status = call_user_func( $stepObj[
'callback'], $installer );
1616 'config-install-success',
1617 $this->
getVar(
'wgServer' ),
1618 $this->
getVar(
'wgScriptPath' )
1620 $this->
setVar(
'_InstallDone',
true );
1623 return $installResults;
1632 $keys = [
'wgSecretKey' => 64 ];
1633 if ( strval( $this->
getVar(
'wgUpgradeKey' ) ) ===
'' ) {
1634 $keys[
'wgUpgradeKey'] = 16;
1672 if (
$user->idForName() == 0 ) {
1673 $user->addToDatabase();
1676 $user->setPassword( $this->
getVar(
'_AdminPassword' ) );
1681 $user->addGroup(
'sysop' );
1682 $user->addGroup(
'bureaucrat' );
1683 $user->addGroup(
'interface-admin' );
1684 if ( $this->
getVar(
'_AdminEmail' ) ) {
1685 $user->setEmail( $this->
getVar(
'_AdminEmail' ) );
1687 $user->saveSettings();
1691 $ssUpdate->doUpdate();
1695 if ( $this->
getVar(
'_Subscribe' ) && $this->
getVar(
'_AdminEmail' ) ) {
1707 'email' => $this->
getVar(
'_AdminEmail' ),
1714 $myLang = $this->
getVar(
'_UserLang' );
1715 if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
1716 $myLang = $myLang ==
'pt-br' ?
'pt_BR' : $myLang;
1717 $params[
'language'] = $myLang;
1722 [
'method' =>
'POST',
'postData' =>
$params ], __METHOD__ )->execute();
1723 if ( !
$res->isOK() ) {
1724 $s->warning(
'config-install-subscribe-fail',
$res->getMessage() );
1727 $s->warning(
'config-install-subscribe-notpossible' );
1740 if (
$title->exists() ) {
1741 $status->warning(
'config-install-mainpage-exists' );
1747 wfMessage(
'mainpagetext' )->inContentLanguage()->
text() .
"\n\n" .
1748 wfMessage(
'mainpagedocfooter' )->inContentLanguage()->
text()
1757 }
catch ( Exception
$e ) {
1759 $status->fatal(
'config-install-mainpage-failed',
$e->getMessage() );
1771 define(
'MW_NO_SESSION_HANDLER', 1 );
1774 $GLOBALS[
'wgUseDatabaseMessages'] =
false;
1778 $GLOBALS[
'wgShowExceptionDetails'] =
true;
1779 $GLOBALS[
'wgShowHostnames'] =
true;
1781 $GLOBALS[
'wgExternalLinkTarget'] =
'_blank';
1784 $GLOBALS[
'wgDisableOutputCompression'] =
true;
1787 $GLOBALS[
'wgCookiePrefix'] =
'mw_installer';
1815 $this->extraInstallSteps[$findStep][] = $callback;
1823 Wikimedia\suppressWarnings();
1824 set_time_limit( 0 );
1825 Wikimedia\restoreWarnings();
envCheckBrokenXML()
Some versions of libxml+PHP break < and > encoding horribly.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Set options of the Parser.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
__construct()
Constructor, always call this from child classes.
static newFromId( $id)
Static factory method for creation from a given user ID.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
processing should stop and the error should be shown to the user * false
createMainpage(DatabaseInstaller $installer)
Insert Main Page with default content.
showMessage( $msg)
UI interface for displaying a short message The parameters are like parameters to wfMessage().
parse( $text, $lineStart=false)
Convert wikitext $text to HTML.
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
Provides a fallback sequence for Config objects.
$wgAutoloadClasses['ReplaceTextHooks']
if(!isset( $args[0])) $lang
A Config instance which stores all settings as a member variable.
showStatusMessage(Status $status)
Show a message to the installing user by using a Status object.
dirIsExecutable( $dir, $url)
Checks if scripts located in the given directory can be executed via the given URL.
envCheckLibicu()
Check the libicu version.
static newMainPage()
Create a new Title for the Main Page.
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 since 1.16! 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 since 1.28! 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
populateSiteStats(DatabaseInstaller $installer)
Install step which adds a row to the site_stats table with appropriate initial values.
array $extraInstallSteps
Extra steps for installation, for things like DatabaseInstallers to modify.
getConnection()
Connect to the database using the administrative user/password currently defined in the session.
array $rightsProfiles
User rights profiles.
envCheckShellLocale()
Environment check for preferred locale in shell.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest to get request data $wgMemc
envCheckUploadsDirectory()
Environment check for the permissions of the uploads directory.
static newFatal( $message)
Factory function for fatal errors.
envPrepServer()
Environment prep for the server hostname.
performInstallation( $startCB, $endCB)
Actually perform the installation.
$mediaWikiAnnounceLanguages
Supported language codes for Mailman.
Show an error when any operation involving passwords fails to run.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
array $dbInstallers
Cached DB installer instances, access using getDBInstaller().
setParserLanguage( $lang)
ParserOptions are constructed before we determined the language, so fix it.
addInstallStep( $callback, $findStep='BEGINNING')
Add an installation step following the given step.
array $internalDefaults
Variables that are stored alongside globals, and are used for any configuration of the installation p...
setPassword( $name, $value)
Set a variable which stores a password, except if the new value is a fake password in which case leav...
envGetDefaultServer()
Helper function to be called from envPrepServer()
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
setVar( $name, $value)
Set a MW configuration variable, or internal installer configuration variable.
Title $parserTitle
Cached Title, used by parse().
array $objectCaches
Known object cache types and the functions used to test for their existence.
int $minMemorySize
Minimum memory size in MB.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
static overrideConfig()
Override the necessary bits of the config to run an installation.
createSysop()
Create the first user account, grant it sysop, bureaucrat and interface-admin rights.
getFakePassword( $realPassword)
Get a fake password for sending back to the user in HTML.
Interface for configuration instances.
envCheckSuhosinMaxValueLength()
Checks if suhosin.get.max_value_length is set, and if so generate a warning because it decreases Reso...
static getLocalisationCache()
Get the LocalisationCache instance.
showError( $msg)
Same as showMessage(), but for displaying errors.
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 & $html
namespace and then decline to actually register it file or subcat img or subcat $title
envPrepPath()
Environment prep for setting $IP and $wgScriptPath.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
envCheckDiff3()
Search for GNU diff3.
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
generateKeys()
Generate $wgSecretKey.
envCheckMemory()
Environment check for available memory.
$wgObjectCaches
Advanced object cache configuration.
getCompiledDBs()
Get a list of DBs supported by current PHP setup.
static getInstance( $id)
Get a cached instance of the specified type of cache object.
envCheckCache()
Environment check for compiled object cache types.
static getExistingLocalSettings()
Determine if LocalSettings.php exists.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
envCheckPath()
Environment check to inform user which paths we've assumed.
doGenerateKeys( $keys)
Generate a secret value for variables using our CryptRand generator.
ParserOptions $parserOptions
Cached ParserOptions, used by parse().
static factory(array $deltas)
Accesses configuration settings from $GLOBALS.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration settings
$wgExternalLinkTarget
Set a default target for external links, e.g.
static array $dbTypes
Known database types.
getVar( $name, $default=null)
Get an MW configuration variable, or internal installer configuration variable.
Content object for wiki text pages.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
getDefaultSkin(array $skinNames)
Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,...
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
findExtensions( $directory='extensions')
Find extensions or skins in a subdirectory of $IP.
static get( $url, $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
Allows to change the fields on the form that will be generated $name
static getInstallerConfig(Config $baseConfig)
Constructs a Config object that contains configuration settings that should be overwritten for the in...
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
array $envPreps
A list of environment preparation methods called by doEnvironmentPreps().
$wgExtensionDirectory
Filesystem extensions directory.
static newGood( $value=null)
Factory function for good results.
array $installSteps
The actual list of installation steps.
wfIsWindows()
Check if the operating system is Windows.
readExtension( $fullJsonFile, $extDeps=[], $skinDeps=[])
getDBInstaller( $type=false)
Get an instance of DatabaseInstaller for the specified DB type.
Base class for DBMS-specific installation helper classes.
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 & $ret
envCheckDB()
Environment check for DB types.
getInstallSteps(DatabaseInstaller $installer)
Get an array of install steps.
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format.
static getMain()
Get the RequestContext object associated with the main request.
array $compiledDBs
List of detected DBs, access using getCompiledDBs().
doEnvironmentChecks()
Do initial checks of the PHP environment.
envCheckGraphics()
Environment check for ImageMagick and GD.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
static apacheModulePresent( $moduleName)
Checks for presence of an Apache module.
Test for PHP+libxml2 bug which breaks XML input subtly with certain versions.
Represents a title within MediaWiki.
envCheckPCRE()
Environment check for the PCRE module.
$wgHooks['ArticleShow'][]
static canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen()
envCheck64Bit()
Checks if we're running on 64 bit or not.
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
array $licenses
License types.
disableTimeLimit()
Disable the time limit for execution.
envCheckServer()
Environment check to inform user which server we've assumed.
const MINIMUM_PCRE_VERSION
The oldest version of PCRE we can support.
static factory( $code)
Get a cached or new language object for a given language code.
findExtensionsByType( $type='extension', $directory='extensions')
Find extensions or skins, and return an array containing the value for 'Name' for each found extensio...
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
static findInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
static getDBTypes()
Get a list of known DB types.
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
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
$mediaWikiAnnounceUrl
URL to mediawiki-announce subscription.
wfIsHHVM()
Check if we are running under HHVM.
includeExtensions()
Installs the auto-detected extensions.
$wgStyleDirectory
Filesystem stylesheets directory.
envCheckGit()
Search for git.
getDocUrl( $page)
Overridden by WebInstaller to provide lastPage parameters.
subscribeToMediaWikiAnnounce(Status $s)
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object Deprecated:
static maybeGetWebserverPrimaryGroup()
On POSIX systems return the primary group of the webserver we're running under.
getExtensionInfo( $type, $parentRelPath, $name)
array $defaultVarNames
MediaWiki configuration globals that will eventually be passed through to LocalSettings....
static getDBInstallerClass( $type)
Get the DatabaseInstaller class name for this type.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
array $envChecks
A list of environment check methods called by doEnvironmentChecks().
envCheckModSecurity()
Scare user to death if they have mod_security or mod_security2.