Base installer class. More...

Inheritance diagram for Installer:

[legend]

Collaboration diagram for 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.

	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=[])
	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.

const	MINIMUM_PCRE_VERSION = '7.2'
	The oldest version of PCRE we can support.

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 the libicu version.

	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 ()
	Environment check for the PCRE module.

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

	envCheckSuhosinMaxValueLength ()
	Checks if suhosin.get.max_value_length is set, and if so generate a warning because it is incompatible with ResourceLoader.

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

	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

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 57 of file Installer.php.

Constructor & Destructor Documentation

◆ __construct()

Installer::__construct ( )

Constructor, always call this from child classes.

Definition at line 412 of file Installer.php.

References $type, doEnvironmentPreps(), getDBInstaller(), getInstallerConfig(), and resetMediaWikiServices().

Member Function Documentation

◆ addInstallStep()

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 1969 of file Installer.php.

◆ apacheModulePresent()

static 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 1231 of file Installer.php.

◆ createMainpage()

Installer::createMainpage ( DatabaseInstaller $installer )

protected

Insert Main Page with default content.

Parameters

DatabaseInstaller $installer

Returns: Status

Definition at line 1872 of file Installer.php.

References $content, $title, EDIT_NEW, User\newSystemUser(), and wfMessage().

◆ createSysop()

Installer::createSysop ( )

protected

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

Returns: Status

Definition at line 1768 of file Installer.php.

References User\newFromName().

◆ dirIsExecutable()

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

Definition at line 1176 of file Installer.php.

References $ext, $file, and $source.

◆ disableLinkPopups()

Installer::disableLinkPopups ( )

Definition at line 801 of file Installer.php.

◆ disableTimeLimit()

Installer::disableTimeLimit ( )

protected

Disable the time limit for execution.

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

Definition at line 1977 of file Installer.php.

Referenced by WebInstaller\execute().

◆ doEnvironmentChecks()

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.

Under the web subclass, it can already be assumed that PHP 5+ is in use and that sessions are working.

Returns: Status

Definition at line 553 of file Installer.php.

◆ doEnvironmentPreps()

Installer::doEnvironmentPreps ( )

Definition at line 578 of file Installer.php.

Referenced by __construct().

◆ doGenerateKeys()

Installer::doGenerateKeys ( $keys )

protected

Generate a secret value for variables using a secure generator.

Parameters

array $keys

Returns: Status

Definition at line 1755 of file Installer.php.

References $keys.

◆ envCheck64Bit()

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 1113 of file Installer.php.

◆ envCheckCache()

Installer::envCheckCache ( )

protected

Environment check for compiled object cache types.

Definition at line 949 of file Installer.php.

◆ envCheckDB()

Installer::envCheckDB ( )

protected

Environment check for DB types.

Returns: bool

Definition at line 846 of file Installer.php.

References $wgLang, and wfMessage().

◆ envCheckDiff3()

Installer::envCheckDiff3 ( )

protected

Search for GNU diff3.

Returns: bool

Definition at line 981 of file Installer.php.

References wfIsWindows().

◆ envCheckGit()

Installer::envCheckGit ( )

protected

Search for git.

Since: 1.22

Returns: bool

Definition at line 1028 of file Installer.php.

References wfIsWindows().

◆ envCheckGraphics()

Installer::envCheckGraphics ( )

protected

Environment check for ImageMagick and GD.

Returns: bool

Definition at line 1004 of file Installer.php.

References wfIsWindows().

◆ envCheckLibicu()

Installer::envCheckLibicu ( )

protected

Check the libicu version.

Definition at line 1124 of file Installer.php.

◆ envCheckMemory()

Installer::envCheckMemory ( )

protected

Environment check for available memory.

Returns: bool

Definition at line 923 of file Installer.php.

References wfShorthandToInteger().

◆ envCheckModSecurity()

Installer::envCheckModSecurity ( )

protected

Scare user to death if they have mod_security or mod_security2.

Returns: bool

Definition at line 968 of file Installer.php.

◆ envCheckPath()

Installer::envCheckPath ( )

protected

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

Returns: bool

Reimplemented in CliInstaller, and WebInstaller.

Definition at line 1063 of file Installer.php.

◆ envCheckPCRE()

Installer::envCheckPCRE ( )

protected

Environment check for the PCRE module.

Note: If this check were to fail, the parser would probably throw an exception before the result of this check is shown to the user.

Returns: bool

Definition at line 892 of file Installer.php.

◆ envCheckServer()

Installer::envCheckServer ( )

protected

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

Returns: bool

Definition at line 1050 of file Installer.php.

◆ envCheckSuhosinMaxValueLength()

Installer::envCheckSuhosinMaxValueLength ( )

protected

Checks if suhosin.get.max_value_length is set, and if so generate a warning because it is incompatible with ResourceLoader.

Returns: bool

Definition at line 1095 of file Installer.php.

◆ envCheckUploadsDirectory()

Installer::envCheckUploadsDirectory ( )

protected

Environment check for the permissions of the uploads directory.

Returns: bool

Definition at line 1076 of file Installer.php.

References $IP.

◆ envGetDefaultServer()

Installer::envGetDefaultServer ( )

abstractprotected

Helper function to be called from envPrepServer()

Returns: string

Reimplemented in CliInstaller, and WebInstaller.

◆ envPrepPath()

Installer::envPrepPath ( )

protected

Environment prep for setting $IP and $wgScriptPath.

Reimplemented in WebInstaller.

Definition at line 1162 of file Installer.php.

References $IP.

◆ envPrepServer()

Installer::envPrepServer ( )

protected

Environment prep for the server hostname.

Definition at line 1146 of file Installer.php.

◆ findExtensions()

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 1271 of file Installer.php.

Referenced by CliInstaller\__construct().

◆ findExtensionsByType()

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 1291 of file Installer.php.

References $file, and $type.

◆ generateKeys()

Installer::generateKeys ( )

Generate $wgSecretKey.

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

Returns: Status

Definition at line 1727 of file Installer.php.

References $keys.

◆ getAutoExtensionData()

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 1584 of file Installer.php.

References AutoLoader\loadFiles(), AutoLoader\registerClasses(), and AutoLoader\registerNamespaces().

◆ getAutoExtensionHookContainer()

Installer::getAutoExtensionHookContainer ( )

Get the hook container previously populated by includeExtensions().

Access: internal: For use by DatabaseInstaller

Since: 1.36

Returns: HookContainer

Definition at line 1611 of file Installer.php.

◆ getAutoExtensionLegacyHooks()

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 1517 of file Installer.php.

◆ getCompiledDBs()

Installer::getCompiledDBs ( )

Get a list of DBs supported by current PHP setup.

Returns: array

Definition at line 613 of file Installer.php.

◆ getDBInstaller()

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 635 of file Installer.php.

References $type.

Referenced by __construct().

◆ getDBInstallerClass()

static 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 624 of file Installer.php.

References $type.

Referenced by UpdateMediaWiki\execute().

◆ getDBTypes()

static Installer::getDBTypes ( )

static

Get a list of known DB types.

Returns: array

Definition at line 536 of file Installer.php.

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

◆ getDefaultSkin()

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 1471 of file Installer.php.

Referenced by CliInstaller\__construct().

◆ getDocUrl()

Installer::getDocUrl ( $page )

protected

Overridden by WebInstaller to provide lastPage parameters.

Parameters

string $page

Returns: string

Reimplemented in WebInstaller.

Definition at line 1258 of file Installer.php.

◆ getExistingLocalSettings()

static Installer::getExistingLocalSettings ( )

static

Determine if LocalSettings.php exists.

If it does, return its variables.

Returns: array|false

Definition at line 655 of file Installer.php.

References $IP, $wgAutoloadClasses, $wgExtensionDirectory, $wgStyleDirectory, wfDetectInstallPath(), and wfDetectLocalSettingsFile().

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

◆ getExtensionInfo()

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 1334 of file Installer.php.

References $path, and $type.

◆ getFakePassword()

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 721 of file Installer.php.

Referenced by WebInstaller\getPasswordBox().

◆ getInstallerConfig()

static 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 374 of file Installer.php.

References $objectCaches, CACHE_ANYTHING, CACHE_DB, CACHE_MEMCACHED, CACHE_NONE, and Config\get().

Referenced by __construct().

◆ getInstallSteps()

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 1632 of file Installer.php.

◆ getParserOptions()

Installer::getParserOptions ( )

Returns: ParserOptions

Definition at line 797 of file Installer.php.

◆ getVar()

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 604 of file Installer.php.

Referenced by CliInstaller\__construct(), CliInstaller\envCheckPath(), WebInstaller\envGetDefaultServer(), CliInstaller\execute(), WebInstaller\execute(), WebInstaller\getCheckBox(), WebInstaller\getPasswordBox(), WebInstaller\getRadioElements(), WebInstaller\getTextArea(), WebInstaller\getTextBox(), and WebInstaller\setupLanguage().

◆ includeExtensionFiles()

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 1541 of file Installer.php.

References $file, $IP, $wgAutoloadClasses, $wgExtensionDirectory, $wgHooks, and $wgStyleDirectory.

◆ includeExtensions()

Installer::includeExtensions ( )

protected

Installs the auto-detected extensions.

Returns: Status

Definition at line 1485 of file Installer.php.

◆ maybeGetWebserverPrimaryGroup()

static 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 749 of file Installer.php.

◆ overrideConfig()

static Installer::overrideConfig ( SettingsBuilder $settings )

static

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

Parameters

SettingsBuilder $settings

Definition at line 1905 of file Installer.php.

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

◆ parse()

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 777 of file Installer.php.

References Parser\stripOuterParagraph().

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

◆ performInstallation()

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 1688 of file Installer.php.

Referenced by CliInstaller\execute().

◆ populateSiteStats()

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 818 of file Installer.php.

References DatabaseInstaller\getConnection().

◆ resetMediaWikiServices()

Installer::resetMediaWikiServices	(	Config	$installerConfig = null,
			$serviceOverrides = [] )

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 per default, namely 'InterwikiLookup' and 'UserOptionsLookup'.

Returns: MediaWikiServices

Exceptions

MWException

Definition at line 472 of file Installer.php.

References $lang, $wgLang, $wgObjectCaches, User\newFromId(), and StubGlobalUser\setUser().

Referenced by __construct().

◆ restoreLinkPopups()

Installer::restoreLinkPopups ( )

Definition at line 805 of file Installer.php.

References $wgExternalLinkTarget.

◆ restoreServices()

Installer::restoreServices ( )

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

Returns: Status

Definition at line 1740 of file Installer.php.

◆ setParserLanguage()

Installer::setParserLanguage ( $lang )

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

Parameters

Language $lang

Definition at line 1248 of file Installer.php.

References $lang.

◆ setPassword()

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 732 of file Installer.php.

Referenced by WebInstaller\setVarsFromRequest().

◆ setVar()

Installer::setVar	(		$name,
			$value )

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

Parameters

string	$name
mixed	$value

Definition at line 590 of file Installer.php.

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

◆ showError()

Installer::showError	(		$msg,
			$params )

abstract

Same as showMessage(), but for displaying errors.

Parameters

string	$msg
	mixed	...$params

Reimplemented in CliInstaller, and WebInstaller.

◆ showMessage()

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	$msg
	mixed	...$params

Reimplemented in CliInstaller, and WebInstaller.

◆ showStatusMessage()

Installer::showStatusMessage ( Status $status )

abstract

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

Parameters

Status $status

Reimplemented in CliInstaller, and WebInstaller.

Member Data Documentation

◆ $autoExtensionHookContainer

HookContainer null Installer::$autoExtensionHookContainer

protected

Definition at line 339 of file Installer.php.

◆ $compiledDBs

array Installer::$compiledDBs

protected

List of detected DBs, access using getCompiledDBs().

Definition at line 83 of file Installer.php.

◆ $dbInstallers

array Installer::$dbInstallers = []

protected

Cached DB installer instances, access using getDBInstaller().

Definition at line 90 of file Installer.php.

◆ $dbTypes

array 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 122 of file Installer.php.

◆ $envChecks

array Installer::$envChecks

protected

Initial value:

= [
        'envCheckDB',
        'envCheckPCRE',
        'envCheckMemory',
        'envCheckCache',
        'envCheckModSecurity',
        'envCheckDiff3',
        'envCheckGraphics',
        'envCheckGit',
        'envCheckServer',
        'envCheckPath',
        'envCheckUploadsDirectory',
        'envCheckLibicu',
        'envCheckSuhosinMaxValueLength',
        '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 139 of file Installer.php.

◆ $envPreps

array Installer::$envPreps

protected

Initial value:

= [
        'envPrepServer',
        'envPrepPath',
    ]

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

Definition at line 161 of file Installer.php.

◆ $extraInstallSteps

array Installer::$extraInstallSteps = []

protected

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

Definition at line 260 of file Installer.php.

◆ $internalDefaults

array 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 209 of file Installer.php.

◆ $licenses

array Installer::$licenses

License types.

Definition at line 302 of file Installer.php.

◆ $minMemorySize

int Installer::$minMemorySize = 50

protected

Minimum memory size in MiB.

Definition at line 97 of file Installer.php.

◆ $objectCaches

array Installer::$objectCaches

protected

Initial value:

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

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

Definition at line 267 of file Installer.php.

Referenced by getInstallerConfig().

◆ $parserOptions

ParserOptions Installer::$parserOptions

protected

Cached ParserOptions, used by parse().

Definition at line 111 of file Installer.php.

◆ $parserTitle

Title Installer::$parserTitle

protected

Cached Title, used by parse().

Definition at line 104 of file Installer.php.

◆ $rightsProfiles

array 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 277 of file Installer.php.

◆ $settings

array Installer::$settings

protected

Definition at line 76 of file Installer.php.

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

◆ MINIMUM_PCRE_VERSION

const Installer::MINIMUM_PCRE_VERSION = '7.2'

The oldest version of PCRE we can support.

Defining this is necessary because PHP may be linked with a system version of PCRE, which may be older than that bundled with the minimum PHP version.

Definition at line 65 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()

◆ envCheckSuhosinMaxValueLength()

◆ envCheckUploadsDirectory()

◆ envGetDefaultServer()

◆ envPrepPath()

◆ envPrepServer()

◆ findExtensions()

◆ findExtensionsByType()

◆ generateKeys()

◆ getAutoExtensionData()

◆ getAutoExtensionHookContainer()

◆ getAutoExtensionLegacyHooks()

◆ getCompiledDBs()

◆ getDBInstaller()

◆ getDBInstallerClass()

◆ getDBTypes()

◆ getDefaultSkin()

◆ getDocUrl()

◆ getExistingLocalSettings()

◆ getExtensionInfo()

◆ getFakePassword()

◆ getInstallerConfig()

◆ getInstallSteps()

◆ getParserOptions()

◆ getVar()

◆ 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

◆ $extraInstallSteps