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.

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

	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.

	restoreLinkPopups ()

	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)
	Display an error message.

	showMessage ( $msg,... $params)
	Display a short neutral message.

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

	showSuccess ( $msg,... $params)
	Display a success message.

	showWarning ( $msg,... $params)
	Display a warning message.

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

static	disableStorage (Config $config, string $lang)
	Reset the global service container and associated global state, disabling storage, to support pre-installation operation.

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	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
	detectWebPaths ()
	This is overridden by the web installer to provide the detected wgScriptPath.

	disableTimeLimit ()
	Disable the time limit for execution.

	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 getDefaultSettings()

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

	getDefaultSettingsOverrides ()
	Override this in a subclass to override the default settings.

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

	getExtensionInfo ( $type, $parentRelPath, $name)

	getTaskFactory ()

	getTaskList ()
	Get a list of tasks to do.

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

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Installer\Installer::__construct ( )

Constructor, always call this from child classes.

Definition at line 420 of file Installer.php.

References MediaWiki\Installer\Installer\disableStorage(), MediaWiki\Installer\Installer\getDBInstaller(), MediaWiki\Installer\Installer\getInstallerConfig(), MediaWiki\Installer\Installer\getVar(), and MediaWiki\Installer\Installer\setParserLanguage().

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

◆ detectWebPaths()

MediaWiki\Installer\Installer::detectWebPaths ( )

protected

This is overridden by the web installer to provide the detected wgScriptPath.

Returns: array

Reimplemented in MediaWiki\Installer\WebInstaller.

Definition at line 483 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 1110 of file Installer.php.

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

◆ disableLinkPopups()

MediaWiki\Installer\Installer::disableLinkPopups ( )

Definition at line 793 of file Installer.php.

◆ disableStorage()

static MediaWiki\Installer\Installer::disableStorage	(	Config	$config,
		string	$lang )

static

Reset the global service container and associated global state, disabling storage, to support pre-installation operation.

Parameters

Config	$config	Config override
string	$lang	Language code

Returns: MediaWikiServices

Definition at line 523 of file Installer.php.

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

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

◆ 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 1561 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 579 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 1080 of file Installer.php.

◆ envCheckCache()

MediaWiki\Installer\Installer::envCheckCache ( )

protected

Environment check for compiled object cache types.

Definition at line 898 of file Installer.php.

◆ envCheckDB()

MediaWiki\Installer\Installer::envCheckDB ( )

protected

Environment check for DB types.

Returns: bool

Definition at line 810 of file Installer.php.

References $wgLang, and wfMessage().

◆ envCheckDiff3()

MediaWiki\Installer\Installer::envCheckDiff3 ( )

protected

Search for GNU diff3.

Returns: bool

Definition at line 930 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 977 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 953 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 1091 of file Installer.php.

◆ envCheckMemory()

MediaWiki\Installer\Installer::envCheckMemory ( )

protected

Environment check for available memory.

Returns: bool

Definition at line 872 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 917 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 1012 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 857 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 999 of file Installer.php.

◆ envCheckUploadsDirectory()

MediaWiki\Installer\Installer::envCheckUploadsDirectory ( )

protected

Environment check for the permissions of the uploads directory.

Returns: bool

Definition at line 1025 of file Installer.php.

References $IP, and $url.

◆ envCheckUploadsServerResponse()

MediaWiki\Installer\Installer::envCheckUploadsServerResponse ( )

protected

Definition at line 1039 of file Installer.php.

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

◆ envGetDefaultServer()

MediaWiki\Installer\Installer::envGetDefaultServer ( )

abstractprotected

Helper function to be called from getDefaultSettings()

Returns: string

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

◆ 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 1205 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 1225 of file Installer.php.

◆ getCompiledDBs()

MediaWiki\Installer\Installer::getCompiledDBs ( )

Get a list of DBs supported by current PHP setup.

Returns: array

Definition at line 626 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 648 of file Installer.php.

Referenced by MediaWiki\Installer\Installer\__construct(), MediaWiki\Installer\WebInstaller\doUpgrade(), and MediaWiki\Installer\WebInstaller\needsUpgrade().

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

◆ getDBTypes()

static MediaWiki\Installer\Installer::getDBTypes ( )

static

Get a list of known DB types.

Returns: array

Definition at line 562 of file Installer.php.

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

◆ getDefaultSettingsOverrides()

MediaWiki\Installer\Installer::getDefaultSettingsOverrides ( )

protected

Override this in a subclass to override the default settings.

Since: 1.44

Returns: array

Definition at line 493 of file Installer.php.

◆ 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 1406 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 1192 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 668 of file Installer.php.

References $IP, $wgAutoloadClasses, $wgExtensionDirectory, $wgStyleDirectory, 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 1269 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 734 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 388 of file Installer.php.

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

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

◆ getParserOptions()

MediaWiki\Installer\Installer::getParserOptions ( )

Returns: ParserOptions

Definition at line 789 of file Installer.php.

◆ getTaskFactory()

MediaWiki\Installer\Installer::getTaskFactory ( )

protected

Definition at line 1452 of file Installer.php.

References MediaWiki\MediaWikiServices\getInstance().

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

◆ getTaskList()

MediaWiki\Installer\Installer::getTaskList ( )

protected

Get a list of tasks to do.

There must be a config-install-$name message defined per step, which will be shown on install.

Returns: TaskList

Definition at line 1434 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 617 of file Installer.php.

◆ overrideConfig()

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

static

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

Definition at line 1492 of file Installer.php.

◆ 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 767 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\showMessage(), MediaWiki\Installer\WebInstaller\showSuccess(), and MediaWiki\Installer\WebInstaller\showWarning().

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

◆ restoreLinkPopups()

MediaWiki\Installer\Installer::restoreLinkPopups ( )

Definition at line 799 of file Installer.php.

References $wgExternalLinkTarget.

◆ setParserLanguage()

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

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

Parameters

Language $lang

Definition at line 1182 of file Installer.php.

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

◆ 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 745 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 603 of file Installer.php.

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

◆ showError()

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

abstract

Display an error message.

Avoid error fatigue in the installer. Use this only if something the user expects has failed and requires intervention to continue. If something non-essential failed that can be continued past with no action, use a warning instead.

Parameters

string \| MessageSpecifier	$msg
	string\|int\|float	...$params Message parameters

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

◆ showMessage()

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

abstract

Display a short neutral message.

Parameters

string \| MessageSpecifier	$msg	String of wikitext that will be converted to HTML, or interface message that will be parsed.
	string\|int\|float	...$params Message parameters, same as wfMessage().

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.

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

◆ showSuccess()

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

abstract

Display a success message.

Parameters

string \| MessageSpecifier	$msg	String of wikitext that will be converted to HTML, or interface message that will be parsed.
	string\|int\|float	...$params Message parameters, same as wfMessage().

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

◆ showWarning()

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

abstract

Display a warning message.

Parameters

string \| MessageSpecifier	$msg	String of wikitext that will be converted to HTML, or interface message that will be parsed.
	string\|int\|float	...$params Message parameters, same as wfMessage().

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

Member Data Documentation

◆ $autoExtensionHookContainer

HookContainer null MediaWiki\Installer\Installer::$autoExtensionHookContainer

protected

Definition at line 327 of file Installer.php.

◆ $compiledDBs

array MediaWiki\Installer\Installer::$compiledDBs

protected

List of detected DBs, access using getCompiledDBs().

Definition at line 96 of file Installer.php.

◆ $dbInstallers

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

protected

Cached DB installer instances, access using getDBInstaller().

Definition at line 103 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 135 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.

In the WebInstaller, variables set here will be saved to the session and will be available to later pages in the same session. But if you need dynamic defaults to be available before the welcome page completes, say in the initial CSS request, add something to getDefaultSettings().

Definition at line 153 of file Installer.php.

◆ $extraInstallSteps

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

protected

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

Definition at line 255 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 212 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 296 of file Installer.php.

◆ $minMemorySize

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

protected

Minimum memory size in MiB.

Definition at line 110 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 262 of file Installer.php.

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

◆ $parserOptions

ParserOptions MediaWiki\Installer\Installer::$parserOptions

protected

Cached ParserOptions, used by parse().

Definition at line 124 of file Installer.php.

◆ $parserTitle

Title MediaWiki\Installer\Installer::$parserTitle

protected

Cached Title, used by parse().

Definition at line 117 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 271 of file Installer.php.

◆ $settings

array MediaWiki\Installer\Installer::$settings

protected

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

◆ detectWebPaths()

◆ dirIsExecutable()

◆ disableLinkPopups()

◆ disableStorage()

◆ disableTimeLimit()

◆ doEnvironmentChecks()

◆ envCheck64Bit()

◆ envCheckCache()

◆ envCheckDB()

◆ envCheckDiff3()

◆ envCheckGit()

◆ envCheckGraphics()

◆ envCheckLibicu()

◆ envCheckMemory()

◆ envCheckModSecurity()

◆ envCheckPath()

◆ envCheckPCRE()

◆ envCheckServer()

◆ envCheckUploadsDirectory()

◆ envCheckUploadsServerResponse()

◆ envGetDefaultServer()

◆ findExtensions()

◆ findExtensionsByType()

◆ getCompiledDBs()

◆ getDBInstaller()

◆ getDBInstallerClass()

◆ getDBTypes()

◆ getDefaultSettingsOverrides()

◆ getDefaultSkin()

◆ getDocUrl()

◆ getExistingLocalSettings()

◆ getExtensionInfo()

◆ getFakePassword()

◆ getInstallerConfig()

◆ getParserOptions()

◆ getTaskFactory()

◆ getTaskList()

◆ getVar()

◆ overrideConfig()

◆ parse()

◆ performInstallation()

◆ restoreLinkPopups()

◆ setParserLanguage()

◆ setPassword()

◆ setVar()

◆ showError()

◆ showMessage()

◆ showStatusMessage()

◆ showSuccess()

◆ showWarning()

Member Data Documentation

◆ $autoExtensionHookContainer

◆ $compiledDBs

◆ $dbInstallers

◆ $dbTypes

◆ $envChecks

◆ $extraInstallSteps

◆ $internalDefaults

◆ $licenses

◆ $minMemorySize

◆ $objectCaches

◆ $parserOptions

◆ $parserTitle

◆ $rightsProfiles

◆ $settings

◆ $virtualDomains