Base installer class. More...

Inherited by MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

Collaboration diagram for MediaWiki\Installer\Installer:

[legend]

Public Member Functions
	__construct ()
	Constructor, always call this from child classes.

	addInstallStep ( $callback, $findStep='BEGINNING')
	Add an installation step following the given step.

	dirIsExecutable ( $dir, $url)
	Checks if scripts located in the given directory can be executed via the given URL.

	disableLinkPopups ()

	doEnvironmentChecks ()
	Do initial checks of the PHP environment.

	doEnvironmentPreps ()

	findExtensions ( $directory='extensions')
	Find extensions or skins in a subdirectory of $IP.

	generateKeys ()
	Generate $wgSecretKey.

	getAutoExtensionHookContainer ()
	Get the hook container previously populated by includeExtensions().

	getCompiledDBs ()
	Get a list of DBs supported by current PHP setup.

	getDBInstaller ( $type=false)
	Get an instance of DatabaseInstaller for the specified DB type.

	getDefaultSkin (array $skinNames)
	Returns a default value to be used for $wgDefaultSkin: normally the DefaultSkin from config-schema.yaml, but will fall back to another if the default skin is missing and some other one is present instead.

	getFakePassword ( $realPassword)
	Get a fake password for sending back to the user in HTML.

	getParserOptions ()

	getVar ( $name, $default=null)
	Get an MW configuration variable, or internal installer configuration variable.

	getVirtualDomains ()
	Get the virtual domains.

	parse ( $text, $lineStart=false)
	Convert wikitext $text to HTML.

	performInstallation ( $startCB, $endCB)
	Actually perform the installation.

	populateSiteStats (DatabaseInstaller $installer)
	Install step which adds a row to the site_stats table with appropriate initial values.

	resetMediaWikiServices (?Config $installerConfig=null, $serviceOverrides=[], bool $disableStorage=false)
	Reset the global service container and associated global state to accommodate different stages of the installation.

	restoreLinkPopups ()

	restoreServices ()
	Restore services that have been redefined in the early stage of installation.

	setParserLanguage ( $lang)
	ParserOptions are constructed before we determined the language, so fix it.

	setPassword ( $name, $value)
	Set a variable which stores a password, except if the new value is a fake password in which case leave it as it is.

	setVar ( $name, $value)
	Set a MW configuration variable, or internal installer configuration variable.

	showError ( $msg,... $params)
	Same as showMessage(), but for displaying errors.

	showMessage ( $msg,... $params)
	UI interface for displaying a short message The parameters are like parameters to wfMessage().

	showStatusMessage (Status $status)
	Show a message to the installing user by using a Status object.

Static Public Member Functions
static	apacheModulePresent ( $moduleName)
	Checks for presence of an Apache module.

static	getDBInstallerClass ( $type)
	Get the DatabaseInstaller class name for this type.

static	getDBTypes ()
	Get a list of known DB types.

static	getExistingLocalSettings ()
	Determine if LocalSettings.php exists.

static	getInstallerConfig (Config $baseConfig)
	Constructs a Config object that contains configuration settings that should be overwritten for the installation process.

static	maybeGetWebserverPrimaryGroup ()
	On POSIX systems return the primary group of the webserver we're running under.

static	overrideConfig (SettingsBuilder $settings)
	Override the necessary bits of the config to run an installation.

Public Attributes
array	$licenses
	License types.

array	$rightsProfiles
	User rights profiles.

Protected Member Functions
	createMainpage (DatabaseInstaller $installer)
	Insert Main Page with default content.

	createSysop ()
	Create the first user account, grant it sysop, bureaucrat and interface-admin rights.

	disableTimeLimit ()
	Disable the time limit for execution.

	doGenerateKeys ( $keys)
	Generate a secret value for variables using a secure generator.

	envCheck64Bit ()
	Checks if we're running on 64 bit or not.

	envCheckCache ()
	Environment check for compiled object cache types.

	envCheckDB ()
	Environment check for DB types.

	envCheckDiff3 ()
	Search for GNU diff3.

	envCheckGit ()
	Search for git.

	envCheckGraphics ()
	Environment check for ImageMagick and GD.

	envCheckLibicu ()
	Check and display the libicu and Unicode versions.

	envCheckMemory ()
	Environment check for available memory.

	envCheckModSecurity ()
	Scare user to death if they have mod_security or mod_security2.

	envCheckPath ()
	Environment check to inform user which paths we've assumed.

	envCheckPCRE ()
	Check for known PCRE-related compatibility issues.

	envCheckServer ()
	Environment check to inform user which server we've assumed.

	envCheckUploadsDirectory ()
	Environment check for the permissions of the uploads directory.

	envCheckUploadsServerResponse ()

	envGetDefaultServer ()
	Helper function to be called from envPrepServer()

	envPrepPath ()
	Environment prep for setting $IP and $wgScriptPath.

	envPrepServer ()
	Environment prep for the server hostname.

	findExtensionsByType ( $type='extension', $directory='extensions')
	Find extensions or skins, and return an array containing the value for 'Name' for each found extension.

	getAutoExtensionData ()
	Auto-detect extensions with an extension.json file.

	getAutoExtensionLegacyHooks ()
	Auto-detect extensions with an old style .php registration file, load the extensions, and return the merged $wgHooks array.

	getDocUrl ( $page)
	Overridden by WebInstaller to provide lastPage parameters.

	getExtensionInfo ( $type, $parentRelPath, $name)

	getInstallSteps (DatabaseInstaller $installer)
	Get an array of install steps.

	includeExtensionFiles ( $files)
	Include the specified extension PHP files.

	includeExtensions ()
	Installs the auto-detected extensions.

Protected Attributes
HookContainer null	$autoExtensionHookContainer

array	$compiledDBs
	List of detected DBs, access using getCompiledDBs().

array	$dbInstallers = []
	Cached DB installer instances, access using getDBInstaller().

array	$envChecks
	A list of environment check methods called by doEnvironmentChecks().

array	$envPreps
	A list of environment preparation methods called by doEnvironmentPreps().

array	$extraInstallSteps = []
	Extra steps for installation, for things like DatabaseInstallers to modify.

array	$internalDefaults
	Variables that are stored alongside globals, and are used for any configuration of the installation process aside from the MediaWiki configuration.

int	$minMemorySize = 50
	Minimum memory size in MiB.

array	$objectCaches
	Known object cache types and the functions used to test for their existence.

ParserOptions	$parserOptions
	Cached ParserOptions, used by parse().

Title	$parserTitle
	Cached Title, used by parse().

array	$settings

array	$virtualDomains = []

Static Protected Attributes
static array	$dbTypes
	Known database types.

Detailed Description

Base installer class.

This class provides the base for installation and update functionality for both MediaWiki core and extensions.

Since: 1.17

Definition at line 90 of file Installer.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Installer\Installer::__construct ( )

Constructor, always call this from child classes.

Definition at line 431 of file Installer.php.

References MediaWiki\Installer\Installer\doEnvironmentPreps(), MediaWiki\Installer\Installer\getDBInstaller(), and MediaWiki\Installer\Installer\resetMediaWikiServices().

Member Function Documentation

◆ addInstallStep()

MediaWiki\Installer\Installer::addInstallStep	(		$callback,
			$findStep = 'BEGINNING' )

Add an installation step following the given step.

Parameters

array	$callback	A valid installation callback array, in this form: [ 'name' => 'some-unique-name', 'callback' => [ $obj, 'function' ] ];
string	$findStep	The step to find. Omit to put the step at the beginning

Definition at line 2024 of file Installer.php.

◆ apacheModulePresent()

static MediaWiki\Installer\Installer::apacheModulePresent ( $moduleName )

static

Checks for presence of an Apache module.

Works only if PHP is running as an Apache module, too.

Parameters

string $moduleName Name of module to check.

Returns: bool

Definition at line 1254 of file Installer.php.

◆ createMainpage()

MediaWiki\Installer\Installer::createMainpage ( DatabaseInstaller $installer )

protected

Insert Main Page with default content.

Parameters

DatabaseInstaller $installer

Returns: Status

Definition at line 1927 of file Installer.php.

References EDIT_NEW, and wfMessage().

◆ createSysop()

MediaWiki\Installer\Installer::createSysop ( )

protected

Create the first user account, grant it sysop, bureaucrat and interface-admin rights.

Returns: Status

Definition at line 1823 of file Installer.php.

◆ dirIsExecutable()

MediaWiki\Installer\Installer::dirIsExecutable	(		$dir,
			$url )

Checks if scripts located in the given directory can be executed via the given URL.

Used only by environment checks.

Parameters

string	$dir
string	$url

Returns: bool|int|string

Reimplemented in MediaWiki\Installer\CliInstaller.

Definition at line 1199 of file Installer.php.

References $source, $url, and MediaWiki\MediaWikiServices\getInstance().

◆ disableLinkPopups()

MediaWiki\Installer\Installer::disableLinkPopups ( )

Definition at line 832 of file Installer.php.

◆ disableTimeLimit()

MediaWiki\Installer\Installer::disableTimeLimit ( )

protected

Disable the time limit for execution.

Some long-running pages (Install, Upgrade) will want to do this

Definition at line 2032 of file Installer.php.

Referenced by MediaWiki\Installer\WebInstaller\execute().

◆ doEnvironmentChecks()

MediaWiki\Installer\Installer::doEnvironmentChecks ( )

Do initial checks of the PHP environment.

Set variables according to the observed environment.

It's possible that this may be called under the CLI SAPI, not the SAPI that the wiki will primarily run under. In that case, the subclass should initialise variables such as wgScriptPath, before calling this function.

It can already be assumed that a supported PHP version is in use. Under the web subclass, it can also be assumed that sessions are working.

Returns: Status

Definition at line 589 of file Installer.php.

◆ doEnvironmentPreps()

MediaWiki\Installer\Installer::doEnvironmentPreps ( )

Definition at line 607 of file Installer.php.

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

◆ doGenerateKeys()

MediaWiki\Installer\Installer::doGenerateKeys ( $keys )

protected

Generate a secret value for variables using a secure generator.

Parameters

array $keys

Returns: Status

Definition at line 1810 of file Installer.php.

◆ envCheck64Bit()

MediaWiki\Installer\Installer::envCheck64Bit ( )

protected

Checks if we're running on 64 bit or not.

32 bit is becoming increasingly hard to support, so let's at least warn people.

Returns: bool

Definition at line 1150 of file Installer.php.

◆ envCheckCache()

MediaWiki\Installer\Installer::envCheckCache ( )

protected

Environment check for compiled object cache types.

Definition at line 968 of file Installer.php.

◆ envCheckDB()

MediaWiki\Installer\Installer::envCheckDB ( )

protected

Environment check for DB types.

Returns: bool

Definition at line 880 of file Installer.php.

References $wgLang, and wfMessage().

◆ envCheckDiff3()

MediaWiki\Installer\Installer::envCheckDiff3 ( )

protected

Search for GNU diff3.

Returns: bool

Definition at line 1000 of file Installer.php.

References ExecutableFinder\findInDefaultPaths(), and wfIsWindows().

◆ envCheckGit()

MediaWiki\Installer\Installer::envCheckGit ( )

protected

Search for git.

Since: 1.22

Returns: bool

Definition at line 1047 of file Installer.php.

References ExecutableFinder\findInDefaultPaths(), and wfIsWindows().

◆ envCheckGraphics()

MediaWiki\Installer\Installer::envCheckGraphics ( )

protected

Environment check for ImageMagick and GD.

Returns: bool

Definition at line 1023 of file Installer.php.

References ExecutableFinder\findInDefaultPaths(), and wfIsWindows().

◆ envCheckLibicu()

MediaWiki\Installer\Installer::envCheckLibicu ( )

protected

Check and display the libicu and Unicode versions.

Definition at line 1161 of file Installer.php.

◆ envCheckMemory()

MediaWiki\Installer\Installer::envCheckMemory ( )

protected

Environment check for available memory.

Returns: bool

Definition at line 942 of file Installer.php.

References wfShorthandToInteger().

◆ envCheckModSecurity()

MediaWiki\Installer\Installer::envCheckModSecurity ( )

protected

Scare user to death if they have mod_security or mod_security2.

Returns: bool

Definition at line 987 of file Installer.php.

◆ envCheckPath()

MediaWiki\Installer\Installer::envCheckPath ( )

protected

Environment check to inform user which paths we've assumed.

Returns: bool

Reimplemented in MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

Definition at line 1082 of file Installer.php.

◆ envCheckPCRE()

MediaWiki\Installer\Installer::envCheckPCRE ( )

protected

Check for known PCRE-related compatibility issues.

Note: We don't bother checking for Unicode support here. If it were missing, the parser would probably throw an exception before the result of this check is shown to the user.

Returns: bool

Definition at line 927 of file Installer.php.

◆ envCheckServer()

MediaWiki\Installer\Installer::envCheckServer ( )

protected

Environment check to inform user which server we've assumed.

Returns: bool

Definition at line 1069 of file Installer.php.

◆ envCheckUploadsDirectory()

MediaWiki\Installer\Installer::envCheckUploadsDirectory ( )

protected

Environment check for the permissions of the uploads directory.

Returns: bool

Definition at line 1095 of file Installer.php.

References $IP, and $url.

◆ envCheckUploadsServerResponse()

MediaWiki\Installer\Installer::envCheckUploadsServerResponse ( )

protected

Definition at line 1109 of file Installer.php.

References $url, and MediaWiki\MediaWikiServices\getInstance().

◆ envGetDefaultServer()

MediaWiki\Installer\Installer::envGetDefaultServer ( )

abstractprotected

Helper function to be called from envPrepServer()

Returns: string

Reimplemented in MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

◆ envPrepPath()

MediaWiki\Installer\Installer::envPrepPath ( )

protected

Environment prep for setting $IP and $wgScriptPath.

Reimplemented in MediaWiki\Installer\WebInstaller.

Definition at line 1185 of file Installer.php.

References $IP.

◆ envPrepServer()

MediaWiki\Installer\Installer::envPrepServer ( )

protected

Environment prep for the server hostname.

Definition at line 1169 of file Installer.php.

◆ findExtensions()

MediaWiki\Installer\Installer::findExtensions ( $directory = 'extensions' )

Find extensions or skins in a subdirectory of $IP.

Returns an array containing the value for 'Name' for each found extension.

Parameters

string $directory Directory to search in, relative to $IP, must be either "extensions" or "skins"

Returns: Status An object containing an error list. If there were no errors, an associative array of information about the extension can be found in $status->value.

Definition at line 1294 of file Installer.php.

Referenced by MediaWiki\Installer\CliInstaller\__construct().

◆ findExtensionsByType()

MediaWiki\Installer\Installer::findExtensionsByType	(		$type = 'extension',
			$directory = 'extensions' )

protected

Find extensions or skins, and return an array containing the value for 'Name' for each found extension.

Parameters

string	$type	Either "extension" or "skin"
string	$directory	Directory to search in, relative to $IP

Returns: Status An object containing an error list. If there were no errors, an associative array of information about the extension can be found in $status->value.

Definition at line 1314 of file Installer.php.

◆ generateKeys()

MediaWiki\Installer\Installer::generateKeys ( )

Generate $wgSecretKey.

Will warn if we had to use an insecure random source.

Returns: Status

Definition at line 1774 of file Installer.php.

◆ getAutoExtensionData()

MediaWiki\Installer\Installer::getAutoExtensionData ( )

protected

Auto-detect extensions with an extension.json file.

Load the extensions, register classes with the autoloader and return the merged registry data.

Returns: array

Definition at line 1620 of file Installer.php.

◆ getAutoExtensionHookContainer()

MediaWiki\Installer\Installer::getAutoExtensionHookContainer ( )

Get the hook container previously populated by includeExtensions().

Access: internal: For use by DatabaseInstaller

Since: 1.36

Returns: HookContainer

Definition at line 1647 of file Installer.php.

◆ getAutoExtensionLegacyHooks()

MediaWiki\Installer\Installer::getAutoExtensionLegacyHooks ( )

protected

Auto-detect extensions with an old style .php registration file, load the extensions, and return the merged $wgHooks array.

Returns: array

Definition at line 1553 of file Installer.php.

◆ getCompiledDBs()

MediaWiki\Installer\Installer::getCompiledDBs ( )

Get a list of DBs supported by current PHP setup.

Returns: array

Definition at line 642 of file Installer.php.

◆ getDBInstaller()

MediaWiki\Installer\Installer::getDBInstaller ( $type = false )

Get an instance of DatabaseInstaller for the specified DB type.

Parameters

mixed $type DB installer for which is needed, false to use default.

Returns: DatabaseInstaller

Definition at line 664 of file Installer.php.

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

◆ getDBInstallerClass()

static MediaWiki\Installer\Installer::getDBInstallerClass ( $type )

static

Get the DatabaseInstaller class name for this type.

Parameters

string $type database type ($wgDBtype)

Returns: string Class name

Since: 1.30

Definition at line 653 of file Installer.php.

◆ getDBTypes()

static MediaWiki\Installer\Installer::getDBTypes ( )

static

Get a list of known DB types.

Returns: array

Definition at line 572 of file Installer.php.

Referenced by MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerExistingWiki\handleExistingUpgrade(), and MediaWiki\Installer\DatabaseUpdater\newForDB().

◆ getDefaultSkin()

MediaWiki\Installer\Installer::getDefaultSkin ( array $skinNames )

Returns a default value to be used for $wgDefaultSkin: normally the DefaultSkin from config-schema.yaml, but will fall back to another if the default skin is missing and some other one is present instead.

Parameters

string[] $skinNames Names of installed skins.

Returns: string

Definition at line 1495 of file Installer.php.

Referenced by MediaWiki\Installer\CliInstaller\__construct().

◆ getDocUrl()

MediaWiki\Installer\Installer::getDocUrl ( $page )

protected

Overridden by WebInstaller to provide lastPage parameters.

Parameters

string $page

Returns: string

Reimplemented in MediaWiki\Installer\WebInstaller.

Definition at line 1281 of file Installer.php.

◆ getExistingLocalSettings()

static MediaWiki\Installer\Installer::getExistingLocalSettings ( )

static

Determine if LocalSettings.php exists.

If it does, return its variables.

Returns: array|false

Definition at line 684 of file Installer.php.

References $IP, $wgAutoloadClasses, $wgExtensionDirectory, $wgStyleDirectory, MediaWiki\MainConfigSchema\listDefaultValues(), wfDetectInstallPath(), and wfDetectLocalSettingsFile().

Referenced by MediaWiki\Installer\CliInstaller\execute(), and MediaWiki\Installer\WebInstallerExistingWiki\execute().

◆ getExtensionInfo()

MediaWiki\Installer\Installer::getExtensionInfo	(	$type,
		$parentRelPath,
		$name )

protected

Parameters

string	$type	Either "extension" or "skin"
string	$parentRelPath	The parent directory relative to $IP
string	$name	The extension or skin name

Returns: Status An object containing an error list. If there were no errors, an associative array of information about the extension can be found in $status->value.

Definition at line 1358 of file Installer.php.

References $path.

◆ getFakePassword()

MediaWiki\Installer\Installer::getFakePassword ( $realPassword )

Get a fake password for sending back to the user in HTML.

This is a security mechanism to avoid compromise of the password in the event of session ID compromise.

Parameters

string $realPassword

Returns: string

Definition at line 750 of file Installer.php.

Referenced by MediaWiki\Installer\WebInstaller\getPasswordBox().

◆ getInstallerConfig()

static MediaWiki\Installer\Installer::getInstallerConfig ( Config $baseConfig )

static

Constructs a Config object that contains configuration settings that should be overwritten for the installation process.

Since: 1.27

Parameters

Config $baseConfig

Returns: Config The config to use during installation.

Definition at line 393 of file Installer.php.

References CACHE_ANYTHING, CACHE_DB, CACHE_MEMCACHED, CACHE_NONE, MediaWiki\MainConfigNames\ConfigRegistry, MediaWiki\Config\Config\get(), MediaWiki\MainConfigNames\MessagesDirs, and MediaWiki\MainConfigNames\ObjectCaches.

◆ getInstallSteps()

MediaWiki\Installer\Installer::getInstallSteps ( DatabaseInstaller $installer )

protected

Get an array of install steps.

Should always be in the format of [ 'name' => 'someuniquename', 'callback' => [ $obj, 'method' ], ] There must be a config-install-$name message defined per step, which will be shown on install.

Parameters

DatabaseInstaller $installer DatabaseInstaller so we can make callbacks

Returns: array[]

Definition at line 1679 of file Installer.php.

◆ getParserOptions()

MediaWiki\Installer\Installer::getParserOptions ( )

Returns: ParserOptions

Definition at line 828 of file Installer.php.

◆ getVar()

MediaWiki\Installer\Installer::getVar	(		$name,
			$default = null )

Get an MW configuration variable, or internal installer configuration variable.

The defaults come from MainConfigSchema. Installer variables are typically prefixed by an underscore.

Parameters

string	$name
mixed \| null	$default

Returns: mixed

Definition at line 633 of file Installer.php.

◆ getVirtualDomains()

MediaWiki\Installer\Installer::getVirtualDomains ( )

Get the virtual domains.

Access: internal: For use by DatabaseInstaller

Since: 1.42

Returns: array

Definition at line 1662 of file Installer.php.

◆ includeExtensionFiles()

MediaWiki\Installer\Installer::includeExtensionFiles ( $files )

protected

Include the specified extension PHP files.

Populate $wgAutoloadClasses and return the LoadExtensionSchemaUpdates hooks.

Parameters

string[] $files

Returns: array LoadExtensionSchemaUpdates legacy hooks

Definition at line 1577 of file Installer.php.

References $IP, $wgAutoloadClasses, $wgExtensionDirectory, $wgHooks, $wgStyleDirectory, and MediaWiki\MainConfigSchema\listDefaultValues().

◆ includeExtensions()

MediaWiki\Installer\Installer::includeExtensions ( )

protected

Installs the auto-detected extensions.

Returns: Status

Definition at line 1520 of file Installer.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ maybeGetWebserverPrimaryGroup()

static MediaWiki\Installer\Installer::maybeGetWebserverPrimaryGroup ( )

static

On POSIX systems return the primary group of the webserver we're running under.

On other systems just returns null.

This is used to advice the user that he should chgrp his mw-config/data/images directory as the webserver user before he can install.

Public because SqliteInstaller needs it, and doesn't subclass Installer.

Returns: mixed

Definition at line 778 of file Installer.php.

◆ overrideConfig()

static MediaWiki\Installer\Installer::overrideConfig ( SettingsBuilder $settings )

static

Override the necessary bits of the config to run an installation.

Parameters

SettingsBuilder $settings

Definition at line 1960 of file Installer.php.

References CACHE_NONE, and MediaWiki\Settings\SettingsBuilder\overrideConfigValues().

◆ parse()

MediaWiki\Installer\Installer::parse	(		$text,
			$lineStart = false )

Convert wikitext $text to HTML.

This is potentially error prone since many parser features require a complete installed MW database. The solution is to just not use those features when you write your messages. This appears to work well enough. Basic formatting and external links work just fine.

But in case a translator decides to throw in a "#ifexist" or internal link or whatever, this function is guarded to catch the attempted DB access and to present some fallback text.

Parameters

string	$text
bool	$lineStart

Returns: string

Definition at line 806 of file Installer.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\Installer\WebInstaller\getCheckBox(), MediaWiki\Installer\WebInstaller\getHelpBox(), MediaWiki\Installer\WebInstaller\getInfoBox(), MediaWiki\Installer\WebInstaller\getRadioElements(), MediaWiki\Installer\WebInstaller\makeDownloadLinkHtml(), and MediaWiki\Installer\WebInstaller\showMessage().

◆ performInstallation()

MediaWiki\Installer\Installer::performInstallation	(		$startCB,
			$endCB )

Actually perform the installation.

Parameters

callable	$startCB	A callback array for the beginning of each step
callable	$endCB	A callback array for the end of each step

Returns: Status[]

Definition at line 1735 of file Installer.php.

Referenced by MediaWiki\Installer\CliInstaller\execute().

◆ populateSiteStats()

MediaWiki\Installer\Installer::populateSiteStats ( DatabaseInstaller $installer )

Install step which adds a row to the site_stats table with appropriate initial values.

Parameters

DatabaseInstaller $installer

Returns: Status

Definition at line 853 of file Installer.php.

References MediaWiki\Installer\DatabaseInstaller\getConnection().

◆ resetMediaWikiServices()

MediaWiki\Installer\Installer::resetMediaWikiServices	(	?Config	$installerConfig = null,
			$serviceOverrides = [],
		bool	$disableStorage = false )

Reset the global service container and associated global state to accommodate different stages of the installation.

Since: 1.35

Parameters

Config \| null	$installerConfig	Config override. If null, the previous config will be inherited.
array	$serviceOverrides	Service definition overrides. Values can be null to disable specific overrides that would be applied by default, namely 'InterwikiLookup' and 'UserOptionsLookup'.
bool	$disableStorage	Whether MediaWikiServices::disableStorage() should be called.

Returns: MediaWikiServices

Definition at line 489 of file Installer.php.

References $wgLang, $wgObjectCaches, MediaWiki\MainConfigNames\DefaultUserOptions, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\ObjectCaches, and MediaWiki\MediaWikiServices\resetGlobalInstance().

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

◆ restoreLinkPopups()

MediaWiki\Installer\Installer::restoreLinkPopups ( )

Definition at line 838 of file Installer.php.

References $wgExternalLinkTarget.

◆ restoreServices()

MediaWiki\Installer\Installer::restoreServices ( )

Restore services that have been redefined in the early stage of installation.

Returns: Status

Definition at line 1787 of file Installer.php.

◆ setParserLanguage()

MediaWiki\Installer\Installer::setParserLanguage ( $lang )

ParserOptions are constructed before we determined the language, so fix it.

Parameters

Language $lang

Definition at line 1271 of file Installer.php.

◆ setPassword()

MediaWiki\Installer\Installer::setPassword	(		$name,
			$value )

Set a variable which stores a password, except if the new value is a fake password in which case leave it as it is.

Parameters

string	$name
mixed	$value

Definition at line 761 of file Installer.php.

Referenced by MediaWiki\Installer\WebInstaller\setVarsFromRequest().

◆ setVar()

MediaWiki\Installer\Installer::setVar	(		$name,
			$value )

Set a MW configuration variable, or internal installer configuration variable.

Parameters

string	$name
mixed	$value

Definition at line 619 of file Installer.php.

Referenced by MediaWiki\Installer\CliInstaller\__construct(), MediaWiki\Installer\WebInstaller\envPrepPath(), MediaWiki\Installer\CliInstaller\execute(), MediaWiki\Installer\WebInstaller\setupLanguage(), and MediaWiki\Installer\WebInstaller\setVarsFromRequest().

◆ showError()

MediaWiki\Installer\Installer::showError	(		$msg,
			$params )

abstract

Same as showMessage(), but for displaying errors.

Parameters

string \| MessageSpecifier	$msg
	mixed	...$params

Reimplemented in MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

◆ showMessage()

MediaWiki\Installer\Installer::showMessage	(		$msg,
			$params )

abstract

UI interface for displaying a short message The parameters are like parameters to wfMessage().

The messages will be in wikitext format, which will be converted to an output format such as HTML or text before being sent to the user.

Parameters

string \| MessageSpecifier	$msg
	mixed	...$params

Reimplemented in MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

◆ showStatusMessage()

MediaWiki\Installer\Installer::showStatusMessage ( Status $status )

abstract

Show a message to the installing user by using a Status object.

Parameters

Status $status

Reimplemented in MediaWiki\Installer\CliInstaller, and MediaWiki\Installer\WebInstaller.

Member Data Documentation

◆ $autoExtensionHookContainer

HookContainer null MediaWiki\Installer\Installer::$autoExtensionHookContainer

protected

Definition at line 357 of file Installer.php.

◆ $compiledDBs

array MediaWiki\Installer\Installer::$compiledDBs

protected

List of detected DBs, access using getCompiledDBs().

Definition at line 108 of file Installer.php.

◆ $dbInstallers

array MediaWiki\Installer\Installer::$dbInstallers = []

protected

Cached DB installer instances, access using getDBInstaller().

Definition at line 115 of file Installer.php.

◆ $dbTypes

array MediaWiki\Installer\Installer::$dbTypes

staticprotected

Initial value:

= [
        'mysql',
        'postgres',
        'sqlite',
    ]

Known database types.

These correspond to the class names <type>Installer, and are also MediaWiki database types valid for $wgDBtype.

To add a new type, create a <type>Installer class and a Database<type> class, and add a config-type-<type> message to MessagesEn.php.

Definition at line 147 of file Installer.php.

◆ $envChecks

array MediaWiki\Installer\Installer::$envChecks

protected

Initial value:

= [
        'envCheckLibicu',
        'envCheckDB',
        'envCheckPCRE',
        'envCheckMemory',
        'envCheckCache',
        'envCheckModSecurity',
        'envCheckDiff3',
        'envCheckGraphics',
        'envCheckGit',
        'envCheckServer',
        'envCheckPath',
        'envCheckUploadsDirectory',
        'envCheckUploadsServerResponse',
        'envCheck64Bit',
    ]

A list of environment check methods called by doEnvironmentChecks().

These may output warnings using showMessage(), and/or abort the installation process by returning false.

For the WebInstaller these are only called on the Welcome page, if these methods have side-effects that should affect later page loads (as well as the generated stylesheet), use envPreps instead.

Definition at line 164 of file Installer.php.

◆ $envPreps

array MediaWiki\Installer\Installer::$envPreps

protected

Initial value:

= [
        'envPrepServer',
        'envPrepPath',
    ]

A list of environment preparation methods called by doEnvironmentPreps().

Definition at line 186 of file Installer.php.

◆ $extraInstallSteps

array MediaWiki\Installer\Installer::$extraInstallSteps = []

protected

Extra steps for installation, for things like DatabaseInstallers to modify.

Definition at line 285 of file Installer.php.

◆ $internalDefaults

array MediaWiki\Installer\Installer::$internalDefaults

protected

Variables that are stored alongside globals, and are used for any configuration of the installation process aside from the MediaWiki configuration.

Map of names to defaults.

Definition at line 234 of file Installer.php.

◆ $licenses

array MediaWiki\Installer\Installer::$licenses

Initial value:

= [
        'cc-by' => [
            'url' => 'https://creativecommons.org/licenses/by/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by.png',
        ],
        'cc-by-sa' => [
            'url' => 'https://creativecommons.org/licenses/by-sa/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
        ],
        'cc-by-nc-sa' => [
            'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
        ],
        'cc-0' => [
            'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-0.png',
        ],
        'gfdl' => [
            'url' => 'https://www.gnu.org/copyleft/fdl.html',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
        ],
        'none' => [
            'url' => '',
            'icon' => '',
            'text' => ''
        ],
    ]

License types.

Definition at line 326 of file Installer.php.

◆ $minMemorySize

int MediaWiki\Installer\Installer::$minMemorySize = 50

protected

Minimum memory size in MiB.

Definition at line 122 of file Installer.php.

◆ $objectCaches

array MediaWiki\Installer\Installer::$objectCaches

protected

Initial value:

= [
        'apcu' => 'apcu_fetch',
    ]

Known object cache types and the functions used to test for their existence.

Definition at line 292 of file Installer.php.

◆ $parserOptions

ParserOptions MediaWiki\Installer\Installer::$parserOptions

protected

Cached ParserOptions, used by parse().

Definition at line 136 of file Installer.php.

◆ $parserTitle

Title MediaWiki\Installer\Installer::$parserTitle

protected

Cached Title, used by parse().

Definition at line 129 of file Installer.php.

◆ $rightsProfiles

array MediaWiki\Installer\Installer::$rightsProfiles

Initial value:

= [
        'wiki' => [],
        'no-anon' => [
            '*' => [ 'edit' => false ]
        ],
        'fishbowl' => [
            '*' => [
                'createaccount' => false,
                'edit' => false,
            ],
        ],
        'private' => [
            '*' => [
                'createaccount' => false,
                'edit' => false,
                'read' => false,
            ],
        ],
    ]

User rights profiles.

Definition at line 301 of file Installer.php.

◆ $settings

array MediaWiki\Installer\Installer::$settings

protected

Definition at line 101 of file Installer.php.

Referenced by MediaWiki\Installer\WebInstaller\execute(), and MediaWiki\Installer\WebInstaller\finish().

◆ $virtualDomains

array MediaWiki\Installer\Installer::$virtualDomains = []

protected

Definition at line 358 of file Installer.php.

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

includes/installer/Installer.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addInstallStep()

◆ apacheModulePresent()

◆ createMainpage()

◆ createSysop()

◆ dirIsExecutable()

◆ disableLinkPopups()

◆ disableTimeLimit()

◆ doEnvironmentChecks()

◆ doEnvironmentPreps()

◆ doGenerateKeys()

◆ envCheck64Bit()

◆ envCheckCache()

◆ envCheckDB()

◆ envCheckDiff3()

◆ envCheckGit()

◆ envCheckGraphics()

◆ envCheckLibicu()

◆ envCheckMemory()

◆ envCheckModSecurity()

◆ envCheckPath()

◆ envCheckPCRE()

◆ envCheckServer()

◆ envCheckUploadsDirectory()

◆ envCheckUploadsServerResponse()

◆ envGetDefaultServer()

◆ envPrepPath()

◆ envPrepServer()

◆ findExtensions()

◆ findExtensionsByType()

◆ generateKeys()

◆ getAutoExtensionData()

◆ getAutoExtensionHookContainer()

◆ getAutoExtensionLegacyHooks()

◆ getCompiledDBs()

◆ getDBInstaller()

◆ getDBInstallerClass()

◆ getDBTypes()

◆ getDefaultSkin()

◆ getDocUrl()

◆ getExistingLocalSettings()

◆ getExtensionInfo()

◆ getFakePassword()

◆ getInstallerConfig()

◆ getInstallSteps()

◆ getParserOptions()

◆ getVar()

◆ getVirtualDomains()

◆ includeExtensionFiles()

◆ includeExtensions()

◆ maybeGetWebserverPrimaryGroup()

◆ overrideConfig()

◆ parse()

◆ performInstallation()

◆ populateSiteStats()

◆ resetMediaWikiServices()

◆ restoreLinkPopups()

◆ restoreServices()

◆ setParserLanguage()

◆ setPassword()

◆ setVar()

◆ showError()

◆ showMessage()

◆ showStatusMessage()

Member Data Documentation

◆ $autoExtensionHookContainer

◆ $compiledDBs

◆ $dbInstallers

◆ $dbTypes

◆ $envChecks

◆ $envPreps