Class for the core installer web interface. More...

Collaboration diagram for MediaWiki\Installer\WebInstaller:

[legend]

Public Member Functions
	__construct (WebRequest $request)

	envCheckPath ()

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

	errorHandler ( $errno, $errstr)
	Temporary error handler for session start debugging.

	execute (array $session)
	Main entry point.

	finish ()
	Clean up from execute()

	getAcceptLanguage ()
	Retrieves MediaWiki language from Accept-Language HTTP header.

	getCheckBox ( $params)
	Get a labelled checkbox to configure a boolean variable.

	getDocUrl ( $page)
	Helper for WebInstallerOutput.

	getFingerprint ()
	Get a hash of data identifying this MW installation.

	getHelpBox ( $msg,... $args)
	Get small text indented help for a preceding form field.

	getInfoBox ( $text, $icon=false, $class='')
	Get HTML for an information message box with an icon.

	getLocalSettingsLocation ()
	If the software package wants the LocalSettings.php file to be placed in a specific location, override this function (see mw-config/overrides/README) to return the path of where the file should be saved, or false for a generic "in the base of your install".

	getLowestUnhappy ()
	Find the next page in sequence that hasn't been completed.

	getPageByName ( $pageName)
	Get a WebInstallerPage by name.

	getPasswordBox ( $params)
	Get a labelled password box to configure a variable.

	getPhpErrors ()

	getRadioElements ( $params)
	Get a set of labelled radio buttons.

	getRadioSet ( $params)
	Get a set of labelled radio buttons.

	getSession ( $name, $default=null)
	Get a session variable.

	getTextArea ( $params)
	Get a labelled textarea to configure a variable.

	getTextBox ( $params)
	Get a labelled text box to configure a variable.

	getUrl ( $query=[])
	Get a URL for submission back to the same script.

	label ( $msg, $forId, $contents, $helpData="")
	Label a control by wrapping a config-input div around it and putting a label before it.

	makeDownloadLinkHtml ()
	Helper for "Download LocalSettings" link.

	makeLinkItem ( $url, $linkText)
	Helper for sidebar links.

	nextTabIndex ()
	Get the next tabindex attribute value.

	outputCss ()
	Output stylesheet for web installer pages.

	reset ()
	We're restarting the installation, reset the session, happyPages, etc.

	setSession ( $name, $value)
	Set a session variable.

	setupLanguage ()
	Initializes language-related variables.

	setVarsFromRequest ( $varNames, $prefix='config_')
	Convenience function to set variables based on form data.

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

	showHelpBox ( $msg,... $params)
	Output a help box.

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

	showStatusBox ( $status)
	Output an error or warning box using a Status object.

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

	startSession ()
	Start the PHP session.

Public Member Functions inherited from MediaWiki\Installer\Installer
	__construct ()
	Constructor, always call this from child classes.

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

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

	disableLinkPopups ()

	doEnvironmentChecks ()
	Do initial checks of the PHP environment.

	doEnvironmentPreps ()

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

	generateKeys ()
	Generate $wgSecretKey.

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

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

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

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

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

	getParserOptions ()

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

	getVirtualDomains ()
	Get the virtual domains.

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

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

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

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

	restoreLinkPopups ()

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

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

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

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

Public Attributes
WebInstallerOutput	$output

string[]	$pageSequence
	The main sequence of page names.

WebRequest	$request
	WebRequest object.

bool	$showSessionWarning = false
	Flag indicating that session data may have been lost.

Public Attributes inherited from MediaWiki\Installer\Installer
array	$licenses
	License types.

array	$rightsProfiles
	User rights profiles.

Protected Member Functions
	envGetDefaultServer ()

Protected Member Functions inherited from MediaWiki\Installer\Installer
	createMainpage (DatabaseInstaller $installer)
	Insert Main Page with default content.

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

	disableTimeLimit ()
	Disable the time limit for execution.

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

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

	envCheckCache ()
	Environment check for compiled object cache types.

	envCheckDB ()
	Environment check for DB types.

	envCheckDiff3 ()
	Search for GNU diff3.

	envCheckGit ()
	Search for git.

	envCheckGraphics ()
	Environment check for ImageMagick and GD.

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

	envCheckMemory ()
	Environment check for available memory.

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

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

	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.

	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.

Static Protected Member Functions
static	infoBox ( $rawHtml, $icon, $alt, $class='')
	Get HTML for an information message box with an icon.

Protected Attributes
string	$currentPageName
	Name of the page we're on.

bool[]	$happyPages
	Array of pages which have declared that they have been submitted, have validated their input, and need no further processing.

int	$helpBoxId = 1
	Numeric index of the help box.

string[]	$otherPages
	Out of sequence pages, selectable by the user at any time.

string[]	$phpErrors
	Captured PHP error text.

array[]	$session
	Cached session array.

bool[]	$skippedPages
	List of "skipped" pages.

int	$tabIndex = 1
	Numeric index of the page we're on.

Protected Attributes inherited from MediaWiki\Installer\Installer
HookContainer null	$autoExtensionHookContainer

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

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

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

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

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

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

int	$minMemorySize = 50
	Minimum memory size in MiB.

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

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

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

array	$settings

array	$virtualDomains = []

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Installer\Installer
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.

Static Protected Attributes inherited from MediaWiki\Installer\Installer
static array	$dbTypes
	Known database types.

Detailed Description

Class for the core installer web interface.

Since: 1.17

Definition at line 43 of file WebInstaller.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Installer\WebInstaller::__construct ( WebRequest $request )

Parameters

WebRequest $request

Definition at line 154 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\$request.

Member Function Documentation

◆ envCheckPath()

MediaWiki\Installer\WebInstaller::envCheckPath ( )

Returns: bool

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 1142 of file WebInstaller.php.

References $path, and MediaWiki\Installer\WebInstaller\showError().

◆ envGetDefaultServer()

MediaWiki\Installer\WebInstaller::envGetDefaultServer ( )

protected

Returns: string

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 1189 of file WebInstaller.php.

References MediaWiki\Installer\Installer\getVar().

◆ envPrepPath()

MediaWiki\Installer\WebInstaller::envPrepPath ( )

Environment prep for setting $IP and $wgScriptPath.

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 1160 of file WebInstaller.php.

References $path, and MediaWiki\Installer\Installer\setVar().

◆ errorHandler()

MediaWiki\Installer\WebInstaller::errorHandler	(		$errno,
			$errstr )

Temporary error handler for session start debugging.

Parameters

int	$errno	Unused
string	$errstr

Definition at line 390 of file WebInstaller.php.

◆ execute()

MediaWiki\Installer\WebInstaller::execute ( array $session )

Main entry point.

Parameters

array[] $session Initial session array

Returns: array[] New session array

Definition at line 167 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\$session, MediaWiki\Installer\Installer\$settings, MediaWiki\Installer\Installer\disableTimeLimit(), MediaWiki\Installer\WebInstaller\finish(), MediaWiki\Installer\WebInstaller\getLowestUnhappy(), MediaWiki\Installer\WebInstaller\getPageByName(), MediaWiki\Installer\WebInstaller\getUrl(), MediaWiki\Installer\Installer\getVar(), MediaWiki\Installer\WebInstaller\outputCss(), and MediaWiki\Installer\WebInstaller\setupLanguage().

◆ finish()

MediaWiki\Installer\WebInstaller::finish ( )

Clean up from execute()

Returns: array[]

Definition at line 399 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\$happyPages, MediaWiki\Installer\WebInstaller\$session, MediaWiki\Installer\Installer\$settings, and MediaWiki\Installer\WebInstaller\$skippedPages.

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

◆ getAcceptLanguage()

MediaWiki\Installer\WebInstaller::getAcceptLanguage ( )

Retrieves MediaWiki language from Accept-Language HTTP header.

Returns: string

Definition at line 504 of file WebInstaller.php.

References $wgLanguageCode, $wgRequest, and MediaWiki\MediaWikiServices\getInstance().

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

◆ getCheckBox()

MediaWiki\Installer\WebInstaller::getCheckBox ( $params )

Get a labelled checkbox to configure a boolean variable.

Parameters

mixed[] $params Parameters are: var: The variable to be configured (required) label: The message name for the label (required) labelAttribs:Additional attributes for the label element (optional) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional)

Returns: string HTML

Definition at line 892 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\getVar(), MediaWiki\Installer\WebInstaller\nextTabIndex(), MediaWiki\Installer\Installer\parse(), and wfMessage().

◆ getDocUrl()

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

Helper for WebInstallerOutput.

Access: internal: For use by WebInstallerOutput

Parameters

string $page

Returns: string

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 1086 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\$currentPageName, and MediaWiki\Installer\WebInstaller\getUrl().

◆ getFingerprint()

MediaWiki\Installer\WebInstaller::getFingerprint ( )

Get a hash of data identifying this MW installation.

This is used by mw-config/index.php to prevent multiple installations of MW on the same cookie domain from interfering with each other.

Returns: string

Definition at line 352 of file WebInstaller.php.

References MW_VERSION.

◆ getHelpBox()

MediaWiki\Installer\WebInstaller::getHelpBox	(		$msg,
			$args )

Get small text indented help for a preceding form field.

Parameters like wfMessage().

Parameters

string	$msg
	mixed	...$args

Returns: string HTML

Definition at line 655 of file WebInstaller.php.

References MediaWiki\Installer\Installer\parse(), and wfMessage().

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

◆ getInfoBox()

MediaWiki\Installer\WebInstaller::getInfoBox	(	$text,
		$icon = false,
		$class = '' )

Get HTML for an information message box with an icon.

Parameters

string \| HtmlArmor	$text	Wikitext to be parsed (from Message::plain) or raw HTML.
string \| false	$icon	Icon name, file in mw-config/images. Default: false
string	$class	Additional class name to add to the wrapper div. Default: Empty string.

Returns: string HTML

Definition at line 637 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\infoBox(), MediaWiki\Installer\Installer\parse(), and wfMessage().

◆ getLocalSettingsLocation()

MediaWiki\Installer\WebInstaller::getLocalSettingsLocation ( )

If the software package wants the LocalSettings.php file to be placed in a specific location, override this function (see mw-config/overrides/README) to return the path of where the file should be saved, or false for a generic "in the base of your install".

Since: 1.27

Returns: string|bool

Definition at line 1135 of file WebInstaller.php.

◆ getLowestUnhappy()

MediaWiki\Installer\WebInstaller::getLowestUnhappy ( )

Find the next page in sequence that hasn't been completed.

Returns: int

Definition at line 300 of file WebInstaller.php.

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

◆ getPageByName()

MediaWiki\Installer\WebInstaller::getPageByName ( $pageName )

Get a WebInstallerPage by name.

Parameters

string $pageName

Returns: WebInstallerPage

Definition at line 443 of file WebInstaller.php.

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

◆ getPasswordBox()

MediaWiki\Installer\WebInstaller::getPasswordBox ( $params )

Get a labelled password box to configure a variable.

Implements password hiding

Parameters

mixed[] $params Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional)

Returns: string HTML

Definition at line 846 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\getFakePassword(), MediaWiki\Installer\WebInstaller\getTextBox(), and MediaWiki\Installer\Installer\getVar().

◆ getPhpErrors()

MediaWiki\Installer\WebInstaller::getPhpErrors ( )

Returns: string[]

Definition at line 1224 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\$phpErrors.

◆ getRadioElements()

MediaWiki\Installer\WebInstaller::getRadioElements ( $params )

Get a set of labelled radio buttons.

You probably want to use getRadioSet(), not this.

See also: getRadioSet

Parameters

mixed[] $params

Returns: string[] HTML

Definition at line 984 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\getVar(), MediaWiki\Installer\WebInstaller\nextTabIndex(), MediaWiki\Installer\Installer\parse(), and wfMessage().

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

◆ getRadioSet()

MediaWiki\Installer\WebInstaller::getRadioSet ( $params )

Get a set of labelled radio buttons.

Parameters

mixed[] $params Parameters are: var: The variable to be configured (required) label: The message name for the label (required) itemLabelPrefix: The message name prefix for the item labels (required) itemLabels: List of message names to use for the item labels instead of itemLabelPrefix, keyed by values values: List of allowed values (required) itemAttribs: Array of attribute arrays, outer key is the value name (optional) commonAttribs: Attribute array applied to all items controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional)

Returns: string HTML

Definition at line 954 of file WebInstaller.php.

References $params, MediaWiki\Installer\WebInstaller\getRadioElements(), and MediaWiki\Installer\WebInstaller\label().

◆ getSession()

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

Get a session variable.

Parameters

string	$name
array \| null	$default

Returns: array|null

Definition at line 457 of file WebInstaller.php.

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

◆ getTextArea()

MediaWiki\Installer\WebInstaller::getTextArea ( $params )

Get a labelled textarea to configure a variable.

Parameters

mixed[] $params Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional)

Returns: string

Definition at line 796 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\getVar(), MediaWiki\Installer\WebInstaller\label(), and MediaWiki\Installer\WebInstaller\nextTabIndex().

◆ getTextBox()

MediaWiki\Installer\WebInstaller::getTextBox ( $params )

Get a labelled text box to configure a variable.

Parameters

mixed[] $params Parameters are: var: The variable to be configured (required) label: The message name for the label (required) attribs: Additional attributes for the input element (optional) controlName: The name for the input element (optional) value: The current value of the variable (optional) help: The html for the help text (optional)

Returns: string HTML

Definition at line 748 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\getVar(), MediaWiki\Installer\WebInstaller\label(), and MediaWiki\Installer\WebInstaller\nextTabIndex().

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

◆ getUrl()

MediaWiki\Installer\WebInstaller::getUrl ( $query = [] )

Get a URL for submission back to the same script.

Parameters

string[] $query

Returns: string

Definition at line 425 of file WebInstaller.php.

References wfArrayToCgi().

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

◆ infoBox()

static MediaWiki\Installer\WebInstaller::infoBox	(	$rawHtml,
		$icon,
		$alt,
		$class = '' )

staticprotected

Get HTML for an information message box with an icon.

Since: 1.36

Parameters

string	$rawHtml	HTML
string	$icon	Path to icon file (used as 'src' attribute)
string	$alt	Alternate text for the icon
string	$class	Additional class name to add to the wrapper div

Returns: string HTML

Definition at line 1238 of file WebInstaller.php.

References MediaWiki\Html\element().

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

◆ label()

MediaWiki\Installer\WebInstaller::label	(	$msg,
		$forId,
		$contents,
		$helpData = "" )

Label a control by wrapping a config-input div around it and putting a label before it.

Parameters

string	$msg
string \| false	$forId
string	$contents	HTML
string	$helpData

Returns: string HTML

Definition at line 706 of file WebInstaller.php.

References wfMessage().

Referenced by MediaWiki\Installer\WebInstaller\getRadioSet(), MediaWiki\Installer\WebInstaller\getTextArea(), and MediaWiki\Installer\WebInstaller\getTextBox().

◆ makeDownloadLinkHtml()

MediaWiki\Installer\WebInstaller::makeDownloadLinkHtml ( )

Helper for "Download LocalSettings" link.

Access: internal: For use in WebInstallerComplete class

Returns: string Html for download link

Definition at line 1116 of file WebInstaller.php.

References MediaWiki\Installer\WebInstaller\getUrl(), MediaWiki\Installer\Installer\parse(), and wfMessage().

◆ makeLinkItem()

MediaWiki\Installer\WebInstaller::makeLinkItem	(		$url,
			$linkText )

Helper for sidebar links.

Access: internal: For use in WebInstallerOutput class

Parameters

string	$url
string	$linkText

Returns: string HTML

Definition at line 1104 of file WebInstaller.php.

References MediaWiki\Html\element().

◆ nextTabIndex()

MediaWiki\Installer\WebInstaller::nextTabIndex ( )

Get the next tabindex attribute value.

Returns: int

Definition at line 476 of file WebInstaller.php.

Referenced by MediaWiki\Installer\WebInstaller\getCheckBox(), MediaWiki\Installer\WebInstaller\getRadioElements(), MediaWiki\Installer\WebInstaller\getTextArea(), and MediaWiki\Installer\WebInstaller\getTextBox().

◆ outputCss()

MediaWiki\Installer\WebInstaller::outputCss ( )

Output stylesheet for web installer pages.

Definition at line 1216 of file WebInstaller.php.

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

◆ reset()

MediaWiki\Installer\WebInstaller::reset ( )

We're restarting the installation, reset the session, happyPages, etc.

Definition at line 412 of file WebInstaller.php.

◆ setSession()

MediaWiki\Installer\WebInstaller::setSession	(		$name,
			$value )

Set a session variable.

Parameters

string	$name	Key for the variable
mixed	$value

Definition at line 467 of file WebInstaller.php.

◆ setupLanguage()

MediaWiki\Installer\WebInstaller::setupLanguage ( )

Initializes language-related variables.

Definition at line 483 of file WebInstaller.php.

References $wgLang, $wgLanguageCode, MediaWiki\Installer\WebInstaller\getAcceptLanguage(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Installer\WebInstaller\getSession(), MediaWiki\Installer\Installer\getVar(), and MediaWiki\Installer\Installer\setVar().

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

◆ setVarsFromRequest()

MediaWiki\Installer\WebInstaller::setVarsFromRequest	(		$varNames,
			$prefix = 'config_' )

Convenience function to set variables based on form data.

Assumes that variables containing "password" in the name are (potentially fake) passwords.

Parameters

string[]	$varNames
string	$prefix	The prefix added to variables to obtain form names

Returns: string[]

Definition at line 1055 of file WebInstaller.php.

References MediaWiki\Installer\Installer\setPassword(), and MediaWiki\Installer\Installer\setVar().

◆ showError()

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

Same as showMessage(), but for displaying errors.

Parameters

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

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 372 of file WebInstaller.php.

References $params, and wfMessage().

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

◆ showHelpBox()

MediaWiki\Installer\WebInstaller::showHelpBox	(		$msg,
			$params )

Output a help box.

Parameters

string	$msg	Key for wfMessage()
	mixed	...$params

Definition at line 675 of file WebInstaller.php.

References $params, and MediaWiki\Installer\WebInstaller\getHelpBox().

◆ showMessage()

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

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

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

Parameters

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

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 680 of file WebInstaller.php.

References $params, MediaWiki\Installer\Installer\parse(), and wfMessage().

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

◆ showStatusBox()

MediaWiki\Installer\WebInstaller::showStatusBox ( $status )

Output an error or warning box using a Status object.

Parameters

Status $status

Definition at line 1031 of file WebInstaller.php.

◆ showStatusMessage()

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

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

Parameters

Status $status

Reimplemented from MediaWiki\Installer\Installer.

Definition at line 688 of file WebInstaller.php.

References MediaWiki\Status\Status\getErrorsArray(), MediaWiki\Status\Status\getWarningsArray(), and MediaWiki\Installer\WebInstaller\showMessage().

◆ startSession()

MediaWiki\Installer\WebInstaller::startSession ( )

Start the PHP session.

This may be called before execute() to start the PHP session.

Exceptions

Exception

Returns: bool

Definition at line 314 of file WebInstaller.php.

References wfIniGetBool().

Member Data Documentation

◆ $currentPageName

string MediaWiki\Installer\WebInstaller::$currentPageName

protected

Name of the page we're on.

Definition at line 149 of file WebInstaller.php.

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

◆ $happyPages

bool [] MediaWiki\Installer\WebInstaller::$happyPages

protected

Array of pages which have declared that they have been submitted, have validated their input, and need no further processing.

Definition at line 112 of file WebInstaller.php.

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

◆ $helpBoxId

int MediaWiki\Installer\WebInstaller::$helpBoxId = 1

protected

Numeric index of the help box.

Definition at line 142 of file WebInstaller.php.

◆ $otherPages

string [] MediaWiki\Installer\WebInstaller::$otherPages

protected

Initial value:

= [
        'Restart',
        'ReleaseNotes',
        'Copying',
        'UpgradeDoc', 
    ]

Out of sequence pages, selectable by the user at any time.

Definition at line 99 of file WebInstaller.php.

◆ $output

WebInstallerOutput MediaWiki\Installer\WebInstaller::$output

Definition at line 48 of file WebInstaller.php.

◆ $pageSequence

string [] MediaWiki\Installer\WebInstaller::$pageSequence

Initial value:

= [
        'Language',
        'ExistingWiki',
        'Welcome',
        'DBConnect',
        'Upgrade',
        'DBSettings',
        'Name',
        'Options',
        'Install',
        'Complete',
    ]

The main sequence of page names.

These will be displayed in turn.

To add a new installer page:

Add it to this WebInstaller::$pageSequence property
Add a "config-page-<name>" message
Add a "WebInstaller<name>" class

Definition at line 81 of file WebInstaller.php.

◆ $phpErrors

string [] MediaWiki\Installer\WebInstaller::$phpErrors

protected

Captured PHP error text.

Temporary.

Definition at line 69 of file WebInstaller.php.

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

◆ $request

WebRequest MediaWiki\Installer\WebInstaller::$request

WebRequest object.

Definition at line 55 of file WebInstaller.php.

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

◆ $session

array [] MediaWiki\Installer\WebInstaller::$session

protected

Cached session array.

Definition at line 62 of file WebInstaller.php.

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

◆ $showSessionWarning

bool MediaWiki\Installer\WebInstaller::$showSessionWarning = false

Flag indicating that session data may have been lost.

Definition at line 128 of file WebInstaller.php.

◆ $skippedPages

bool [] MediaWiki\Installer\WebInstaller::$skippedPages

protected

List of "skipped" pages.

These are pages that will automatically continue to the next page on any GET request. To avoid breaking the "back" button, they need to be skipped during a back operation.

Definition at line 121 of file WebInstaller.php.

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

◆ $tabIndex

int MediaWiki\Installer\WebInstaller::$tabIndex = 1

protected

Numeric index of the page we're on.

Definition at line 135 of file WebInstaller.php.

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

includes/installer/WebInstaller.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ envCheckPath()

◆ envGetDefaultServer()

◆ envPrepPath()

◆ errorHandler()

◆ execute()

◆ finish()

◆ getAcceptLanguage()

◆ getCheckBox()

◆ getDocUrl()

◆ getFingerprint()

◆ getHelpBox()

◆ getInfoBox()

◆ getLocalSettingsLocation()

◆ getLowestUnhappy()

◆ getPageByName()

◆ getPasswordBox()

◆ getPhpErrors()

◆ getRadioElements()

◆ getRadioSet()

◆ getSession()

◆ getTextArea()

◆ getTextBox()

◆ getUrl()

◆ infoBox()

◆ label()

◆ makeDownloadLinkHtml()

◆ makeLinkItem()

◆ nextTabIndex()

◆ outputCss()

◆ reset()

◆ setSession()

◆ setupLanguage()

◆ setVarsFromRequest()

◆ showError()

◆ showHelpBox()

◆ showMessage()

◆ showStatusBox()

◆ showStatusMessage()

◆ startSession()

Member Data Documentation

◆ $currentPageName

◆ $happyPages

◆ $helpBoxId

◆ $otherPages

◆ $output

◆ $pageSequence

◆ $phpErrors

◆ $request

◆ $session

◆ $showSessionWarning

◆ $skippedPages

◆ $tabIndex