Base installer class. More...

Inheritance diagram for Installer:

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.
	exportVars ()
	Exports all wg* variables stored by the installer into global scope.
	findExtensions ()
	Finds extensions that follow the format /extensions/Name/Name.php, and returns an array containing the value for 'Name' for each found extension.
	generateKeys ()
	Generate $wgSecretKey.
	getDBInstaller ($type=false)
	Get an instance of DatabaseInstaller for the specified DB type.
	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.
	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)
	Same as showMessage(), but for displaying errors.
	showMessage ($msg)
	UI interface for displaying a short message The parameters are like parameters to wfMsg().
	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	getDBTypes ()
	Get a list of known DB types.
static	getExistingLocalSettings ()
	Determine if LocalSettings.php exists.
static	locateExecutable ($path, $names, $versionInfo=false)
	Search a path for any of the given executable names.
static	locateExecutableInDefaultPaths ($names, $versionInfo=false)
	Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
static	maybeGetWebserverPrimaryGroup ()
	On POSIX systems return the primary group of the webserver we're running under.
static	overrideConfig ()
	Override the necessary bits of the config to run an installation.
Public Attributes
	$licenses
	$rightsProfiles
const	MINIMUM_PHP_VERSION = '5.2.3'
Protected Member Functions
	createMainpage (DatabaseInstaller $installer)
	Insert Main Page with default content.
	createSysop ()
	Create the first user account, grant it sysop and bureaucrat rights.
	disableTimeLimit ()
	Disable the time limit for execution.
	doGenerateKeys ($keys)
	Generate a secret value for variables using our CryptRand generator.
	envCheckBrokenXML ()
	Some versions of libxml+PHP break < and > encoding horribly.
	envCheckCache ()
	Environment check for compiled object cache types.
	envCheckCtype ()
	envCheckDB ()
	Environment check for DB types.
	envCheckDiff3 ()
	Search for GNU diff3.
	envCheckExtension ()
	Environment check for setting the preferred PHP file extension.
	envCheckGraphics ()
	Environment check for ImageMagick and GD.
	envCheckLibicu ()
	Check the libicu version.
	envCheckMagicQuotes ()
	Environment check for magic_quotes_runtime.
	envCheckMagicSybase ()
	Environment check for magic_quotes_sybase.
	envCheckMbstring ()
	Environment check for mbstring.func_overload.
	envCheckMemory ()
	Environment check for available memory.
	envCheckModSecurity ()
	Scare user to death if they have mod_security.
	envCheckPath ()
	Environment check for setting $IP and $wgScriptPath.
	envCheckPCRE ()
	Environment check for the PCRE module.
	envCheckPHP531 ()
	Test PHP (probably 5.3.1, but it could regress again) to make sure that reference parameters to __call() are not converted to null.
	envCheckRegisterGlobals ()
	Environment check for register_globals.
	envCheckSafeMode ()
	Environment check for safe_mode.
	envCheckServer ()
	Environment check for the server hostname.
	envCheckShellLocale ()
	TODO: document.
	envCheckSuhosinMaxValueLength ()
	Checks if suhosin.get.max_value_length is set, and if so, sets $wgResourceLoaderMaxQueryLength to that value in the generated LocalSettings file.
	envCheckUploadsDirectory ()
	TODO: document.
	envCheckXML ()
	Environment check for the XML module.
	envCheckZE1 ()
	Environment check for zend.ze1_compatibility_mode.
	envGetDefaultServer ()
	Helper function to be called from envCheckServer()
	getDocUrl ($page)
	Overridden by WebInstaller to provide lastPage parameters.
	getInstallSteps (DatabaseInstaller $installer)
	Get an array of install steps.
	includeExtensions ()
	Installs the auto-detected extensions.
	unicodeChar ($c)
	Convert a hex string representing a Unicode code point to that code point.
Static Protected Member Functions
static	getPossibleBinPaths ()
	Get an array of likely places we can find executables.
Protected Attributes
	$dbInstallers = array()
	$defaultVarNames
	$envChecks
	$extraInstallSteps = array()
	$internalDefaults
	$mediaWikiAnnounceLanguages
	Supported language codes for Mailman.
	$mediaWikiAnnounceUrl = 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce'
	URL to mediawiki-announce subscription.
	$minMemorySize = 50
	$objectCaches
	$parserOptions
	$parserTitle
	$settings
Static Protected Attributes
static	$dbTypes
Private Member Functions
	subscribeToMediaWikiAnnounce (Status $s)
Private Attributes
	$installSteps = array()

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

Constructor & Destructor Documentation

Installer::__construct ( )

Constructor, always call this from child classes.

Definition at line 318 of file Installer.php.

References $wgExtensionMessagesFiles, $wgUser, LBFactory\disableBackend(), getDBInstaller(), Language\getLocalisationCache(), User\newFromId(), Title\newFromText(), ParserOptions\setEditSection(), and setVar().

Referenced by CliInstaller\__construct(), and WebInstaller\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

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

Add an installation step following the given step.

Parameters:

$callback	Array A valid installation callback array, in this form: array( 'name' => 'some-unique-name', 'callback' => array( $obj, 'function' ) );
$findStep	String the step to find. Omit to put the step at the beginning

Definition at line 1590 of file Installer.php.

static Installer::apacheModulePresent ( $ moduleName ) [static]

Checks for presence of an Apache module.

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

Parameters:

$moduleName String: Name of module to check.

Returns:: bool

Definition at line 1230 of file Installer.php.

Installer::createMainpage ( DatabaseInstaller $ installer ) [protected]

Insert Main Page with default content.

Parameters:

$installer DatabaseInstaller

Returns:: Status

Definition at line 1538 of file Installer.php.

References $page, WikiPage\factory(), User\newFromName(), Status\newGood(), Title\newMainPage(), and wfMsgForContent().

Here is the call graph for this function:

Installer::createSysop ( ) [protected]

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

Returns:: Status

Definition at line 1465 of file Installer.php.

References $user, getVar(), Status\newFatal(), User\newFromName(), Status\newGood(), and subscribeToMediaWikiAnnounce().

Here is the call graph for this function:

Installer::dirIsExecutable	(	$	dir,
		$	url
	)

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

Used only by environment checks.

Reimplemented in CliInstaller.

Definition at line 1183 of file Installer.php.

References $dir, $ext, $file, $url, Http\get(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by envCheckUploadsDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::disableLinkPopups ( )

Definition at line 578 of file Installer.php.

Installer::disableTimeLimit ( ) [protected]

Disable the time limit for execution.

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

Definition at line 1598 of file Installer.php.

References wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by WebInstaller\execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References Status\newFatal(), Status\newGood(), setVar(), and showMessage().

Here is the call graph for this function:

Installer::doGenerateKeys ( $ keys ) [protected]

Generate a secret value for variables using our CryptRand generator.

Produce a warning if the random source was insecure.

Parameters:

$keys Array

Returns:: Status

Definition at line 1437 of file Installer.php.

References $keys, $wgLang, MWCryptRand\generateHex(), Status\newGood(), setVar(), and MWCryptRand\wasStrong().

Referenced by generateKeys().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::envCheckBrokenXML ( ) [protected]

Some versions of libxml+PHP break < and > encoding horribly.

Definition at line 676 of file Installer.php.

References $test, and showError().

Here is the call graph for this function:

Installer::envCheckCache ( ) [protected]

Environment check for compiled object cache types.

Definition at line 813 of file Installer.php.

References setVar(), showMessage(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckCtype ( ) [protected]

Definition at line 1097 of file Installer.php.

References showError().

Here is the call graph for this function:

Installer::envCheckDB ( ) [protected]

Environment check for DB types.

Returns:: bool

Definition at line 627 of file Installer.php.

References $wgLang, getDBInstaller(), getVar(), setVar(), showError(), showStatusMessage(), and wfMsg().

Here is the call graph for this function:

Installer::envCheckDiff3 ( ) [protected]

Search for GNU diff3.

Definition at line 843 of file Installer.php.

References locateExecutableInDefaultPaths(), setVar(), and showMessage().

Here is the call graph for this function:

Installer::envCheckExtension ( ) [protected]

Environment check for setting the preferred PHP file extension.

Definition at line 908 of file Installer.php.

References $ext, and setVar().

Here is the call graph for this function:

Installer::envCheckGraphics ( ) [protected]

Environment check for ImageMagick and GD.

Definition at line 860 of file Installer.php.

References locateExecutableInDefaultPaths(), setVar(), showMessage(), and wfIsWindows().

Here is the call graph for this function:

Installer::envCheckLibicu ( ) [protected]

Check the libicu version.

Definition at line 1054 of file Installer.php.

References showMessage(), unicodeChar(), and UtfNormal\UNORM_NFC.

Here is the call graph for this function:

Installer::envCheckMagicQuotes ( ) [protected]

Environment check for magic_quotes_runtime.

Definition at line 700 of file Installer.php.

References showError(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckMagicSybase ( ) [protected]

Environment check for magic_quotes_sybase.

Definition at line 710 of file Installer.php.

References showError(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckMbstring ( ) [protected]

Environment check for mbstring.func_overload.

Definition at line 720 of file Installer.php.

References showError(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckMemory ( ) [protected]

Environment check for available memory.

Definition at line 787 of file Installer.php.

References $limit, $n, setVar(), showMessage(), and wfShorthandToInteger().

Here is the call graph for this function:

Installer::envCheckModSecurity ( ) [protected]

Scare user to death if they have mod_security.

Definition at line 834 of file Installer.php.

References showMessage().

Here is the call graph for this function:

Installer::envCheckPath ( ) [protected]

Environment check for setting $IP and $wgScriptPath.

Returns:: bool

Reimplemented in WebInstaller, and CliInstaller.

Definition at line 896 of file Installer.php.

References $IP, getVar(), setVar(), and showMessage().

Here is the call graph for this function:

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

References showError(), wfRestoreWarnings(), and wfSuppressWarnings().

Here is the call graph for this function:

Installer::envCheckPHP531 ( ) [protected]

Test PHP (probably 5.3.1, but it could regress again) to make sure that reference parameters to __call() are not converted to null.

Definition at line 688 of file Installer.php.

References $test, and showError().

Here is the call graph for this function:

Installer::envCheckRegisterGlobals ( ) [protected]

Environment check for register_globals.

Definition at line 667 of file Installer.php.

References showMessage(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckSafeMode ( ) [protected]

Environment check for safe_mode.

Definition at line 740 of file Installer.php.

References setVar(), showMessage(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envCheckServer ( ) [protected]

Environment check for the server hostname.

Definition at line 880 of file Installer.php.

References envGetDefaultServer(), setVar(), and showMessage().

Here is the call graph for this function:

Installer::envCheckShellLocale ( ) [protected]

TODO: document.

Returns:: bool

Definition at line 922 of file Installer.php.

References $lines, getVar(), setVar(), wfArrayMap(), and wfShellExec().

Here is the call graph for this function:

Installer::envCheckSuhosinMaxValueLength ( ) [protected]

Checks if suhosin.get.max_value_length is set, and if so, sets $wgResourceLoaderMaxQueryLength to that value in the generated LocalSettings file.

Definition at line 1014 of file Installer.php.

References setVar(), and showMessage().

Here is the call graph for this function:

Installer::envCheckUploadsDirectory ( ) [protected]

TODO: document.

Definition at line 995 of file Installer.php.

References $dir, $IP, $url, dirIsExecutable(), getVar(), and showMessage().

Here is the call graph for this function:

Installer::envCheckXML ( ) [protected]

Environment check for the XML module.

Definition at line 750 of file Installer.php.

References showError().

Here is the call graph for this function:

Installer::envCheckZE1 ( ) [protected]

Environment check for zend.ze1_compatibility_mode.

Definition at line 730 of file Installer.php.

References showError(), and wfIniGetBool().

Here is the call graph for this function:

Installer::envGetDefaultServer ( ) [abstract, protected]

Helper function to be called from envCheckServer()

Returns:: String

Reimplemented in WebInstaller, and CliInstaller.

Referenced by envCheckServer().

Here is the caller graph for this function:

Installer::exportVars ( )

Exports all wg* variables stored by the installer into global scope.

Definition at line 615 of file Installer.php.

Referenced by WebInstaller\execute().

Here is the caller graph for this function:

Installer::findExtensions ( )

Finds extensions that follow the format /extensions/Name/Name.php, and returns an array containing the value for 'Name' for each found extension.

Returns:: array

Definition at line 1266 of file Installer.php.

References $file, and getVar().

Here is the call graph for this function:

Installer::generateKeys ( )

Generate $wgSecretKey.

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

Returns:: Status

Definition at line 1422 of file Installer.php.

References $keys, doGenerateKeys(), and getVar().

Here is the call graph for this function:

Installer::getDBInstaller ( $ type = false )

Get an instance of DatabaseInstaller for the specified DB type.

Parameters:

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

Returns:: DatabaseInstaller

Definition at line 445 of file Installer.php.

References getVar().

Referenced by LocalSettingsGenerator\__construct(), __construct(), envCheckDB(), and performInstallation().

Here is the call graph for this function:

Here is the caller graph for this function:

static Installer::getDBTypes ( ) [static]

Get a list of known DB types.

Returns:: array

Definition at line 369 of file Installer.php.

References $dbTypes.

Referenced by WebInstaller_ExistingWiki\handleExistingUpgrade(), and DatabaseUpdater\newForDB().

Here is the caller graph for this function:

Installer::getDocUrl ( $ page ) [protected]

Overridden by WebInstaller to provide lastPage parameters.

Parameters:

$page string

Returns:: string

Reimplemented in WebInstaller.

Definition at line 1256 of file Installer.php.

References $page.

static Installer::getExistingLocalSettings ( ) [static]

Determine if LocalSettings.php exists.

If it does, return its variables, merged with those from AdminSettings.php, as an array.

Returns:: Array

Definition at line 466 of file Installer.php.

References $IP, wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by CliInstaller\execute(), WebInstaller_ExistingWiki\execute(), and DatabaseUpdater\loadExtensions().

Here is the call graph for this function:

Here is the caller graph for this function:

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:

$realPassword String

Returns:: string

Definition at line 495 of file Installer.php.

Referenced by WebInstaller\getPasswordBox().

Here is the caller graph for this function:

Installer::getInstallSteps ( DatabaseInstaller $ installer ) [protected]

Get an array of install steps.

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

Parameters:

$installer DatabaseInstaller so we can make callbacks

Returns:: array

Definition at line 1337 of file Installer.php.

References getVar().

Referenced by performInstallation().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::getParserOptions ( )

Returns:: ParserOptions

Definition at line 574 of file Installer.php.

static Installer::getPossibleBinPaths ( ) [static, protected]

Get an array of likely places we can find executables.

Check a bunch of known Unix-like defaults, as well as the PATH environment variable (which should maybe make it work for Windows?)

Returns:: Array

Definition at line 1111 of file Installer.php.

Installer::getVar	(	$	name,
		$	default = `null`
	)

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

The defaults come from $GLOBALS (ultimately DefaultSettings.php). Installer variables are typically prefixed by an underscore.

Parameters:

$name	String
$default	Mixed

Returns:: mixed

Definition at line 430 of file Installer.php.

Referenced by LocalSettingsGenerator\__construct(), CliInstaller\__construct(), createSysop(), envCheckDB(), CliInstaller\envCheckPath(), envCheckPath(), envCheckShellLocale(), envCheckUploadsDirectory(), CliInstaller\envGetDefaultServer(), WebInstaller\execute(), findExtensions(), generateKeys(), WebInstaller\getCheckBox(), getDBInstaller(), getInstallSteps(), WebInstaller\getPasswordBox(), WebInstaller\getRadioSet(), WebInstaller\getTextArea(), WebInstaller\getTextBox(), includeExtensions(), WebInstaller\setupLanguage(), and subscribeToMediaWikiAnnounce().

Here is the caller graph for this function:

Installer::includeExtensions ( ) [protected]

Installs the auto-detected extensions.

Returns:: Status

Definition at line 1293 of file Installer.php.

References $IP, $wgAutoloadClasses, $wgHooks, getVar(), and Status\newGood().

Here is the call graph for this function:

static Installer::locateExecutable	(	$	path,
		$	names,
		$	versionInfo = `false`
	)		`[static]`

Search a path for any of the given executable names.

Returns the executable name if found. Also checks the version string returned by each executable.

Used only by environment checks.

Parameters:

$path	String: path to search
$names	Array of executable names
$versionInfo	Boolean false or array with two members: 0 => Command to run for version check, with $1 for the full executable name 1 => String to compare the output with

If $versionInfo is not false, only executables with a version matching $versionInfo[1] will be returned.

Definition at line 1135 of file Installer.php.

References $command, $file, $path, wfEscapeShellArg(), wfRestoreWarnings(), wfShellExec(), and wfSuppressWarnings().

Referenced by locateExecutableInDefaultPaths().

Here is the call graph for this function:

Here is the caller graph for this function:

static Installer::locateExecutableInDefaultPaths	(	$	names,
		$	versionInfo = `false`
	)		`[static]`

Same as locateExecutable(), but checks in getPossibleBinPaths() by default.

See also:: locateExecutable()

Parameters:

$names
$versionInfo	bool

Returns:: bool|string

Definition at line 1168 of file Installer.php.

References $path, and locateExecutable().

Referenced by envCheckDiff3(), envCheckGraphics(), and Maintenance\readlineEmulation().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Referenced by SqliteInstaller\dataDirOKmaybeCreate().

Here is the caller graph for this function:

static Installer::overrideConfig ( ) [static]

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

Definition at line 1559 of file Installer.php.

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:

$text	String
$lineStart	Boolean

Returns:: String

Definition at line 554 of file Installer.php.

References $out, and $wgParser.

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

Here is the caller graph for this function:

Installer::performInstallation	(	$	startCB,
		$	endCB
	)

Actually perform the installation.

Parameters:

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

Returns:: Array of Status objects

Definition at line 1389 of file Installer.php.

References getDBInstaller(), getInstallSteps(), and setVar().

Referenced by CliInstaller\execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::populateSiteStats ( DatabaseInstaller $ installer )

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

Parameters:

$installer DatabaseInstaller

Returns:: Status

Definition at line 595 of file Installer.php.

References DatabaseInstaller\getConnection(), and Status\newGood().

Here is the call graph for this function:

Installer::restoreLinkPopups ( )

Definition at line 582 of file Installer.php.

References $wgExternalLinkTarget.

Installer::setParserLanguage ( $ lang )

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

Parameters:

$lang Language

Definition at line 1246 of file Installer.php.

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:

$name	String
$value	Mixed

Definition at line 506 of file Installer.php.

References setVar().

Referenced by WebInstaller\setVarsFromRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::setVar	(	$	name,
		$	value
	)

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

Parameters:

$name	String
$value	Mixed

Definition at line 416 of file Installer.php.

Referenced by CliInstaller\__construct(), __construct(), doEnvironmentChecks(), doGenerateKeys(), envCheckCache(), envCheckDB(), envCheckDiff3(), envCheckExtension(), envCheckGraphics(), envCheckMemory(), envCheckPath(), WebInstaller\envCheckPath(), envCheckSafeMode(), envCheckServer(), envCheckShellLocale(), envCheckSuhosinMaxValueLength(), performInstallation(), setPassword(), WebInstaller\setupLanguage(), and WebInstaller\setVarsFromRequest().

Here is the caller graph for this function:

Installer::showError ( $ msg ) [abstract]

Same as showMessage(), but for displaying errors.

Parameters:

$msg

Reimplemented in WebInstaller, and CliInstaller.

Referenced by envCheckBrokenXML(), envCheckCtype(), envCheckDB(), envCheckMagicQuotes(), envCheckMagicSybase(), envCheckMbstring(), envCheckPCRE(), envCheckPHP531(), envCheckXML(), and envCheckZE1().

Here is the caller graph for this function:

Installer::showMessage ( $ msg ) [abstract]

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

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:

$msg

Reimplemented in WebInstaller, and CliInstaller.

Referenced by doEnvironmentChecks(), envCheckCache(), envCheckDiff3(), envCheckGraphics(), envCheckLibicu(), envCheckMemory(), envCheckModSecurity(), envCheckPath(), envCheckRegisterGlobals(), envCheckSafeMode(), envCheckServer(), envCheckSuhosinMaxValueLength(), and envCheckUploadsDirectory().

Here is the caller graph for this function:

Installer::showStatusMessage ( Status $ status ) [abstract]

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

Parameters:

$status Status

Reimplemented in WebInstaller, and CliInstaller.

Referenced by envCheckDB().

Here is the caller graph for this function:

Installer::subscribeToMediaWikiAnnounce ( Status $ s ) [private]

Parameters:

$s Status

Definition at line 1506 of file Installer.php.

References $res, MWHttpRequest\canMakeRequests(), MWHttpRequest\factory(), getVar(), and Status\warning().

Referenced by createSysop().

Here is the call graph for this function:

Here is the caller graph for this function:

Installer::unicodeChar ( $ c ) [protected]

Convert a hex string representing a Unicode code point to that code point.

Parameters:

$c String

Returns:: string

Definition at line 1032 of file Installer.php.

Referenced by envCheckLibicu().

Here is the caller graph for this function:

Member Data Documentation

Installer::$dbInstallers = array() [protected]

Definition at line 39 of file Installer.php.

Installer::$dbTypes [static, protected]

Initial value:

 array(
                'mysql',
                'postgres',
                'oracle',
                'sqlite',
                'ibm_db2',
        )

Definition at line 71 of file Installer.php.

Referenced by getDBTypes().

Installer::$defaultVarNames [protected]

Definition at line 120 of file Installer.php.

Installer::$envChecks [protected]

Initial value:

 array(
                'envCheckDB',
                'envCheckRegisterGlobals',
                'envCheckBrokenXML',
                'envCheckPHP531',
                'envCheckMagicQuotes',
                'envCheckMagicSybase',
                'envCheckMbstring',
                'envCheckZE1',
                'envCheckSafeMode',
                'envCheckXML',
                'envCheckPCRE',
                'envCheckMemory',
                'envCheckCache',
                'envCheckModSecurity',
                'envCheckDiff3',
                'envCheckGraphics',
                'envCheckServer',
                'envCheckPath',
                'envCheckExtension',
                'envCheckShellLocale',
                'envCheckUploadsDirectory',
                'envCheckLibicu',
                'envCheckSuhosinMaxValueLength',
                'envCheckCtype',
        )

Definition at line 86 of file Installer.php.

Installer::$extraInstallSteps = array() [protected]

Definition at line 199 of file Installer.php.

Installer::$installSteps = array() [private]

Definition at line 192 of file Installer.php.

Installer::$internalDefaults [protected]

Initial value:

 array(
                '_UserLang' => 'en',
                '_Environment' => false,
                '_CompiledDBs' => array(),
                '_SafeMode' => false,
                '_RaiseMemory' => false,
                '_UpgradeDone' => false,
                '_InstallDone' => false,
                '_Caches' => array(),
                '_InstallPassword' => '',
                '_SameAccount' => true,
                '_CreateDBAccount' => false,
                '_NamespaceType' => 'site-name',
                '_AdminName' => '', 
                '_AdminPassword' => '',
                '_AdminPassword2' => '',
                '_AdminEmail' => '',
                '_Subscribe' => false,
                '_SkipOptional' => 'continue',
                '_RightsProfile' => 'wiki',
                '_LicenseCode' => 'none',
                '_CCDone' => false,
                '_Extensions' => array(),
                '_MemCachedServers' => '',
                '_UpgradeKeySupplied' => false,
                '_ExistingDBSettings' => false,
        )

Definition at line 159 of file Installer.php.

Installer::$licenses

Definition at line 242 of file Installer.php.

Installer::$mediaWikiAnnounceLanguages [protected]

Initial value:

 array(
                'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
                'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
                'sl', 'sr', 'sv', 'tr', 'uk'
        )

Supported language codes for Mailman.

Definition at line 288 of file Installer.php.

Installer::$mediaWikiAnnounceUrl = 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce' [protected]

URL to mediawiki-announce subscription.

Definition at line 283 of file Installer.php.

Installer::$minMemorySize = 50 [protected]

Definition at line 46 of file Installer.php.

Installer::$objectCaches [protected]

Initial value:

 array(
                'xcache' => 'xcache_get',
                'apc' => 'apc_fetch',
                'wincache' => 'wincache_ucache_get'
        )

Definition at line 206 of file Installer.php.

Installer::$parserOptions [protected]

Definition at line 60 of file Installer.php.

Installer::$parserTitle [protected]

Definition at line 53 of file Installer.php.

Installer::$rightsProfiles

Initial value:

 array(
                'wiki' => array(),
                'no-anon' => array(
                        '*' => array( 'edit' => false )
                ),
                'fishbowl' => array(
                        '*' => array(
                                'createaccount' => false,
                                'edit' => false,
                        ),
                ),
                'private' => array(
                        '*' => array(
                                'createaccount' => false,
                                'edit' => false,
                                'read' => false,
                        ),
                ),
        )

Definition at line 217 of file Installer.php.

Installer::$settings [protected]

Definition at line 32 of file Installer.php.

const Installer::MINIMUM_PHP_VERSION = '5.2.3'

Definition at line 27 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

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation