MediaWiki  master
WebInstaller Class Reference

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

Inheritance diagram for WebInstaller:
Collaboration diagram for WebInstaller:

Public Member Functions

 __construct (WebRequest $request)
 
 envCheckPath ()
 
 envPrepPath ()
 
 errorHandler ( $errno, $errstr)
 Temporary error handler for session start debugging. More...
 
 execute (array $session)
 Main entry point. More...
 
 finish ()
 Clean up from execute() More...
 
 getAcceptLanguage ()
 Retrieves MediaWiki language from Accept-Language HTTP header. More...
 
 getCheckBox ( $params)
 Get a labelled checkbox to configure a boolean variable. More...
 
 getDocUrl ( $page)
 Helper for WebInstallerOutput. More...
 
 getErrorBox ( $text)
 Get HTML for an error box with an icon. More...
 
 getFingerprint ()
 Get a hash of data identifying this MW installation. More...
 
 getHelpBox ( $msg,... $args)
 Get small text indented help for a preceding form field. More...
 
 getInfoBox ( $text, $icon=false, $class=false)
 Get HTML for an information message box with an icon. More...
 
 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". More...
 
 getLowestUnhappy ()
 Find the next page in sequence that hasn't been completed. More...
 
 getPageByName ( $pageName)
 Get a WebInstallerPage by name. More...
 
 getPasswordBox ( $params)
 Get a labelled password box to configure a variable. More...
 
 getPhpErrors ()
 
 getRadioElements ( $params)
 Get a set of labelled radio buttons. More...
 
 getRadioSet ( $params)
 Get a set of labelled radio buttons. More...
 
 getSession ( $name, $default=null)
 Get a session variable. More...
 
 getTextArea ( $params)
 Get a labelled textarea to configure a variable. More...
 
 getTextBox ( $params)
 Get a labelled text box to configure a variable. More...
 
 getUrl ( $query=[])
 Get a URL for submission back to the same script. More...
 
 getWarningBox ( $text)
 Get HTML for a warning box with an icon. More...
 
 label ( $msg, $forId, $contents, $helpData="")
 Label a control by wrapping a config-input div around it and putting a label before it. More...
 
 makeDownloadLinkHtml ()
 Helper for "Download LocalSettings" link. More...
 
 makeLinkItem ( $url, $linkText)
 Helper for sidebar links. More...
 
 nextTabIndex ()
 Get the next tabindex attribute value. More...
 
 outputCss ()
 Output stylesheet for web installer pages. More...
 
 reset ()
 We're restarting the installation, reset the session, happyPages, etc. More...
 
 setSession ( $name, $value)
 Set a session variable. More...
 
 setupLanguage ()
 Initializes language-related variables. More...
 
 setVarsFromRequest ( $varNames, $prefix='config_')
 Convenience function to set variables based on form data. More...
 
 showError ( $msg,... $params)
 Show an error message in a box. More...
 
 showHelpBox ( $msg,... $params)
 Output a help box. More...
 
 showMessage ( $msg,... $params)
 Show a short informational message. More...
 
 showStatusBox ( $status)
 Output an error or warning box using a Status object. More...
 
 showStatusMessage (Status $status)
 
 startSession ()
 Start the PHP session. More...
 
- Public Member Functions inherited from Installer
 __construct ()
 Constructor, always call this from child classes. More...
 
 addInstallStep ( $callback, $findStep='BEGINNING')
 Add an installation step following the given step. More...
 
 dirIsExecutable ( $dir, $url)
 Checks if scripts located in the given directory can be executed via the given URL. More...
 
 disableLinkPopups ()
 
 doEnvironmentChecks ()
 Do initial checks of the PHP environment. More...
 
 doEnvironmentPreps ()
 
 findExtensions ( $directory='extensions')
 Find extensions or skins in a subdirectory of $IP. More...
 
 generateKeys ()
 Generate $wgSecretKey. More...
 
 getCompiledDBs ()
 Get a list of DBs supported by current PHP setup. More...
 
 getDBInstaller ( $type=false)
 Get an instance of DatabaseInstaller for the specified DB type. More...
 
 getDefaultSkin (array $skinNames)
 Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings, but will fall back to another if the default skin is missing and some other one is present instead. More...
 
 getFakePassword ( $realPassword)
 Get a fake password for sending back to the user in HTML. More...
 
 getParserOptions ()
 
 getVar ( $name, $default=null)
 Get an MW configuration variable, or internal installer configuration variable. More...
 
 parse ( $text, $lineStart=false)
 Convert wikitext $text to HTML. More...
 
 performInstallation ( $startCB, $endCB)
 Actually perform the installation. More...
 
 populateSiteStats (DatabaseInstaller $installer)
 Install step which adds a row to the site_stats table with appropriate initial values. More...
 
 restoreLinkPopups ()
 
 setParserLanguage ( $lang)
 ParserOptions are constructed before we determined the language, so fix it. More...
 
 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. More...
 
 setVar ( $name, $value)
 Set a MW configuration variable, or internal installer configuration variable. More...
 
 showError ( $msg,... $params)
 Same as showMessage(), but for displaying errors. More...
 
 showMessage ( $msg,... $params)
 UI interface for displaying a short message The parameters are like parameters to wfMessage(). More...
 
 showStatusMessage (Status $status)
 Show a message to the installing user by using a Status object. More...
 

Public Attributes

WebInstallerOutput $output
 
string [] $pageSequence
 The main sequence of page names. More...
 
WebRequest $request
 WebRequest object. More...
 
bool $showSessionWarning = false
 Flag indicating that session data may have been lost. More...
 
- Public Attributes inherited from Installer
array array array $licenses
 License types. More...
 
array array $rightsProfiles
 User rights profiles. More...
 
const MINIMUM_PCRE_VERSION = '7.2'
 The oldest version of PCRE we can support. More...
 

Protected Member Functions

 envGetDefaultServer ()
 
- Protected Member Functions inherited from Installer
 createMainpage (DatabaseInstaller $installer)
 Insert Main Page with default content. More...
 
 createSysop ()
 Create the first user account, grant it sysop, bureaucrat and interface-admin rights. More...
 
 disableTimeLimit ()
 Disable the time limit for execution. More...
 
 doGenerateKeys ( $keys)
 Generate a secret value for variables using a secure generator. More...
 
 envCheck64Bit ()
 Checks if we're running on 64 bit or not. More...
 
 envCheckBrokenXML ()
 Some versions of libxml+PHP break < and > encoding horribly. More...
 
 envCheckCache ()
 Environment check for compiled object cache types. More...
 
 envCheckDB ()
 Environment check for DB types. More...
 
 envCheckDiff3 ()
 Search for GNU diff3. More...
 
 envCheckGit ()
 Search for git. More...
 
 envCheckGraphics ()
 Environment check for ImageMagick and GD. More...
 
 envCheckLibicu ()
 Check the libicu version. More...
 
 envCheckMemory ()
 Environment check for available memory. More...
 
 envCheckModSecurity ()
 Scare user to death if they have mod_security or mod_security2. More...
 
 envCheckPath ()
 Environment check to inform user which paths we've assumed. More...
 
 envCheckPCRE ()
 Environment check for the PCRE module. More...
 
 envCheckServer ()
 Environment check to inform user which server we've assumed. More...
 
 envCheckShellLocale ()
 Environment check for preferred locale in shell. More...
 
 envCheckSuhosinMaxValueLength ()
 Checks if suhosin.get.max_value_length is set, and if so generate a warning because it decreases ResourceLoader performance. More...
 
 envCheckUploadsDirectory ()
 Environment check for the permissions of the uploads directory. More...
 
 envGetDefaultServer ()
 Helper function to be called from envPrepServer() More...
 
 envPrepPath ()
 Environment prep for setting $IP and $wgScriptPath. More...
 
 envPrepServer ()
 Environment prep for the server hostname. More...
 
 findExtensionsByType ( $type='extension', $directory='extensions')
 Find extensions or skins, and return an array containing the value for 'Name' for each found extension. More...
 
 getDocUrl ( $page)
 Overridden by WebInstaller to provide lastPage parameters. More...
 
 getExtensionInfo ( $type, $parentRelPath, $name)
 
 getInstallSteps (DatabaseInstaller $installer)
 Get an array of install steps. More...
 
 includeExtensions ()
 Installs the auto-detected extensions. More...
 

Protected Attributes

string $currentPageName
 Name of the page we're on. More...
 
bool [] $happyPages
 Array of pages which have declared that they have been submitted, have validated their input, and need no further processing. More...
 
int $helpBoxId = 1
 Numeric index of the help box. More...
 
string [] $otherPages
 Out of sequence pages, selectable by the user at any time. More...
 
string [] $phpErrors
 Captured PHP error text. More...
 
array [] $session
 Cached session array. More...
 
bool [] $skippedPages
 List of "skipped" pages. More...
 
int $tabIndex = 1
 Numeric index of the page we're on. More...
 
- Protected Attributes inherited from Installer
array $compiledDBs
 List of detected DBs, access using getCompiledDBs(). More...
 
array $dbInstallers = []
 Cached DB installer instances, access using getDBInstaller(). More...
 
array $defaultVarNames
 MediaWiki configuration globals that will eventually be passed through to LocalSettings.php. More...
 
array $envChecks
 A list of environment check methods called by doEnvironmentChecks(). More...
 
array $envPreps
 A list of environment preparation methods called by doEnvironmentPreps(). More...
 
array $extraInstallSteps = []
 Extra steps for installation, for things like DatabaseInstallers to modify. More...
 
array $internalDefaults
 Variables that are stored alongside globals, and are used for any configuration of the installation process aside from the MediaWiki configuration. More...
 
 $mediaWikiAnnounceLanguages
 Supported language codes for Mailman. More...
 
array array array $mediaWikiAnnounceUrl
 URL to mediawiki-announce subscription. More...
 
int $minMemorySize = 50
 Minimum memory size in MB. More...
 
array $objectCaches
 Known object cache types and the functions used to test for their existence. More...
 
ParserOptions $parserOptions
 Cached ParserOptions, used by parse(). More...
 
Title $parserTitle
 Cached Title, used by parse(). More...
 
array $settings
 

Private Member Functions

 endPageWrapper ()
 Output some stuff after a page is finished. More...
 
 getPageListItem ( $pageName, $enabled, $currentPageName)
 Get a list item for the page list. More...
 
 outputLS ()
 Actually output LocalSettings.php for download. More...
 
 startPageWrapper ( $currentPageName)
 Called by execute() before page output starts, to show a page list. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Installer
static apacheModulePresent ( $moduleName)
 Checks for presence of an Apache module. More...
 
static getDBInstallerClass ( $type)
 Get the DatabaseInstaller class name for this type. More...
 
static getDBTypes ()
 Get a list of known DB types. More...
 
static getExistingLocalSettings ()
 Determine if LocalSettings.php exists. More...
 
static getInstallerConfig (Config $baseConfig)
 Constructs a Config object that contains configuration settings that should be overwritten for the installation process. More...
 
static maybeGetWebserverPrimaryGroup ()
 On POSIX systems return the primary group of the webserver we're running under. More...
 
static overrideConfig ()
 Override the necessary bits of the config to run an installation. More...
 
- Static Protected Attributes inherited from Installer
static array $dbTypes
 Known database types. More...
 

Detailed Description

Class for the core installer web interface.

Since
1.17

Definition at line 32 of file WebInstaller.php.

Constructor & Destructor Documentation

◆ __construct()

WebInstaller::__construct ( WebRequest  $request)
Parameters
WebRequest$request

Definition at line 144 of file WebInstaller.php.

References $request, and request.

Member Function Documentation

◆ endPageWrapper()

WebInstaller::endPageWrapper ( )
private

Output some stuff after a page is finished.

Definition at line 625 of file WebInstaller.php.

Referenced by execute().

◆ envCheckPath()

WebInstaller::envCheckPath ( )
Returns
bool

Definition at line 1151 of file WebInstaller.php.

References $path, and showError().

◆ envGetDefaultServer()

WebInstaller::envGetDefaultServer ( )
protected
Returns
string

Definition at line 1198 of file WebInstaller.php.

References WebRequest\detectServer().

◆ envPrepPath()

WebInstaller::envPrepPath ( )

Definition at line 1169 of file WebInstaller.php.

References $path, and Installer\setVar().

◆ errorHandler()

WebInstaller::errorHandler (   $errno,
  $errstr 
)

Temporary error handler for session start debugging.

Parameters
int$errnoUnused
string$errstr

Definition at line 398 of file WebInstaller.php.

◆ execute()

WebInstaller::execute ( array  $session)

Main entry point.

Parameters
array[]$session Initial session array
Returns
array[] New session array

Definition at line 157 of file WebInstaller.php.

References $GLOBALS, $session, Installer\$settings, as, Installer\disableTimeLimit(), endPageWrapper(), finish(), getLowestUnhappy(), getPageByName(), getUrl(), Installer\getVar(), outputCss(), outputLS(), request, settings, setupLanguage(), and startPageWrapper().

◆ finish()

WebInstaller::finish ( )

Clean up from execute()

Returns
array[]

Definition at line 407 of file WebInstaller.php.

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

Referenced by execute().

◆ getAcceptLanguage()

WebInstaller::getAcceptLanguage ( )

Retrieves MediaWiki language from Accept-Language HTTP header.

Returns
string

Definition at line 511 of file WebInstaller.php.

References $lang, $wgLanguageCode, $wgRequest, as, Language\fetchLanguageNames(), and null.

Referenced by setupLanguage().

◆ getCheckBox()

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

Definition at line 908 of file WebInstaller.php.

References $params, Xml\check(), Installer\getVar(), nextTabIndex(), Installer\parse(), plain, Html\rawElement(), and wfMessage().

◆ getDocUrl()

WebInstaller::getDocUrl (   $page)

Helper for WebInstallerOutput.

Definition at line 1095 of file WebInstaller.php.

References $currentPageName, $query, and getUrl().

◆ getErrorBox()

WebInstaller::getErrorBox (   $text)

Get HTML for an error box with an icon.

Parameters
string$textWikitext, get this with wfMessage()->plain()
Returns
string

Definition at line 640 of file WebInstaller.php.

References getInfoBox().

Referenced by showError(), and showStatusBox().

◆ getFingerprint()

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 355 of file WebInstaller.php.

References $GLOBALS, request, and serialize().

◆ getHelpBox()

WebInstaller::getHelpBox (   $msg,
  $args 
)

Get small text indented help for a preceding form field.

Parameters like wfMessage().

Parameters
string$msg
Returns
string

Definition at line 682 of file WebInstaller.php.

References $args, $html, Installer\parse(), and wfMessage().

Referenced by showHelpBox().

◆ getInfoBox()

WebInstaller::getInfoBox (   $text,
  $icon = false,
  $class = false 
)

Get HTML for an information message box with an icon.

Parameters
string | HtmlArmor$textWikitext to be parsed (from Message::plain) or raw HTML.
string | bool$iconIcon name, file in mw-config/images. Default: false
string | bool$classAdditional class name to add to the wrapper div. Default: false.
Returns
string HTML

Definition at line 663 of file WebInstaller.php.

References $html, false, HtmlArmor\getHtml(), Html\infoBox(), Installer\parse(), and wfMessage().

Referenced by getErrorBox(), and getWarningBox().

◆ getLocalSettingsLocation()

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 1144 of file WebInstaller.php.

◆ getLowestUnhappy()

WebInstaller::getLowestUnhappy ( )

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

Returns
int

Definition at line 309 of file WebInstaller.php.

Referenced by execute().

◆ getPageByName()

WebInstaller::getPageByName (   $pageName)

Get a WebInstallerPage by name.

Parameters
string$pageName
Returns
WebInstallerPage

Definition at line 451 of file WebInstaller.php.

Referenced by execute().

◆ getPageListItem()

WebInstaller::getPageListItem (   $pageName,
  $enabled,
  $currentPageName 
)
private

Get a list item for the page list.

Parameters
string$pageName
bool$enabled
string$currentPageName
Returns
string

Definition at line 575 of file WebInstaller.php.

References $currentPageName, $link, $name, $query, $s, Html\element(), getUrl(), and wfMessage().

Referenced by startPageWrapper().

◆ getPasswordBox()

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

Definition at line 878 of file WebInstaller.php.

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

◆ getPhpErrors()

WebInstaller::getPhpErrors ( )
Returns
string[]

Definition at line 1232 of file WebInstaller.php.

References $phpErrors.

◆ getRadioElements()

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
array

Definition at line 995 of file WebInstaller.php.

References $params, $value, as, Installer\getVar(), nextTabIndex(), Installer\parse(), plain, Xml\radio(), Xml\tags(), and wfMessage().

Referenced by getRadioSet().

◆ getRadioSet()

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

Definition at line 965 of file WebInstaller.php.

References $params, $s, $value, as, getRadioElements(), and label().

◆ getSession()

WebInstaller::getSession (   $name,
  $default = null 
)

Get a session variable.

Parameters
string$name
array | null$default
Returns
array

Definition at line 465 of file WebInstaller.php.

References $name.

Referenced by setupLanguage().

◆ getTextArea()

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 829 of file WebInstaller.php.

References $params, Installer\getVar(), label(), nextTabIndex(), and Xml\textarea().

◆ getTextBox()

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

Definition at line 782 of file WebInstaller.php.

References $params, Installer\getVar(), Xml\input(), label(), and nextTabIndex().

Referenced by getPasswordBox().

◆ getUrl()

WebInstaller::getUrl (   $query = [])

Get a URL for submission back to the same script.

Parameters
string[]$query
Returns
string

Definition at line 433 of file WebInstaller.php.

References $query, request, and wfArrayToCgi().

Referenced by execute(), getDocUrl(), getPageListItem(), and makeDownloadLinkHtml().

◆ getWarningBox()

WebInstaller::getWarningBox (   $text)

Get HTML for a warning box with an icon.

Parameters
string$textWikitext, get this with wfMessage()->plain()
Returns
string

Definition at line 651 of file WebInstaller.php.

References getInfoBox().

Referenced by showStatusBox().

◆ label()

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$forId
string$contents
string$helpData
Returns
string

Definition at line 741 of file WebInstaller.php.

References Xml\tags(), and wfMessage().

Referenced by getRadioSet(), getTextArea(), and getTextBox().

◆ makeDownloadLinkHtml()

WebInstaller::makeDownloadLinkHtml ( )

Helper for "Download LocalSettings" link.

Definition at line 1125 of file WebInstaller.php.

References getUrl(), Installer\parse(), Html\rawElement(), and wfMessage().

◆ makeLinkItem()

WebInstaller::makeLinkItem (   $url,
  $linkText 
)

Helper for sidebar links.

Definition at line 1113 of file WebInstaller.php.

References Html\element(), and Html\rawElement().

◆ nextTabIndex()

WebInstaller::nextTabIndex ( )

Get the next tabindex attribute value.

Returns
int

Definition at line 484 of file WebInstaller.php.

Referenced by getCheckBox(), getRadioElements(), getTextArea(), and getTextBox().

◆ outputCss()

WebInstaller::outputCss ( )

Output stylesheet for web installer pages.

Definition at line 1224 of file WebInstaller.php.

References request.

Referenced by execute().

◆ outputLS()

WebInstaller::outputLS ( )
private

Actually output LocalSettings.php for download.

SecurityCheck-XSS

Definition at line 1207 of file WebInstaller.php.

References as, InstallerOverrides\getLocalSettingsGenerator(), Installer\getVar(), and request.

Referenced by execute().

◆ reset()

WebInstaller::reset ( )

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

Definition at line 420 of file WebInstaller.php.

References settings.

◆ setSession()

WebInstaller::setSession (   $name,
  $value 
)

Set a session variable.

Parameters
string$nameKey for the variable
mixed$value

Definition at line 475 of file WebInstaller.php.

References $name, and $value.

◆ setupLanguage()

WebInstaller::setupLanguage ( )

Initializes language-related variables.

Definition at line 491 of file WebInstaller.php.

References $wgContLang, $wgLang, $wgLanguageCode, Language\factory(), getAcceptLanguage(), RequestContext\getMain(), getSession(), Installer\getVar(), null, request, and Installer\setVar().

Referenced by execute().

◆ setVarsFromRequest()

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$prefixThe prefix added to variables to obtain form names
Returns
string[]

Definition at line 1064 of file WebInstaller.php.

References $name, $value, as, null, request, Installer\setPassword(), and Installer\setVar().

◆ showError()

WebInstaller::showError (   $msg,
  $params 
)

Show an error message in a box.

Parameters are like wfMessage(), or alternatively, pass a Message object in.

Parameters
string | Message$msg
mixed...$params

Definition at line 381 of file WebInstaller.php.

References $params, getErrorBox(), and wfMessage().

Referenced by envCheckPath().

◆ showHelpBox()

WebInstaller::showHelpBox (   $msg,
  $params 
)

Output a help box.

Parameters
string$msgKey for wfMessage()
mixed...$params

Definition at line 702 of file WebInstaller.php.

References $html, $params, and getHelpBox().

◆ showMessage()

WebInstaller::showMessage (   $msg,
  $params 
)

Show a short informational message.

Output looks like a list.

Parameters
string$msg
mixed...$params

Definition at line 714 of file WebInstaller.php.

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

Referenced by showStatusMessage().

◆ showStatusBox()

WebInstaller::showStatusBox (   $status)

Output an error or warning box using a Status object.

Parameters
Status$status

Definition at line 1040 of file WebInstaller.php.

References getErrorBox(), and getWarningBox().

◆ showStatusMessage()

WebInstaller::showStatusMessage ( Status  $status)
Parameters
Status$status

Definition at line 724 of file WebInstaller.php.

References as, Status\getErrorsArray(), Status\getWarningsArray(), and showMessage().

◆ startPageWrapper()

WebInstaller::startPageWrapper (   $currentPageName)
private

Called by execute() before page output starts, to show a page list.

Parameters
string$currentPageName

Definition at line 531 of file WebInstaller.php.

References $s, as, Html\element(), getPageListItem(), text, and wfMessage().

Referenced by execute().

◆ startSession()

WebInstaller::startSession ( )

Start the PHP session.

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

Exceptions
Exception
Returns
bool

Definition at line 323 of file WebInstaller.php.

References $e, and wfIniGetBool().

Member Data Documentation

◆ $currentPageName

string WebInstaller::$currentPageName
protected

Name of the page we're on.

Definition at line 139 of file WebInstaller.php.

Referenced by getDocUrl(), and getPageListItem().

◆ $happyPages

bool [] 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 102 of file WebInstaller.php.

Referenced by finish().

◆ $helpBoxId

int WebInstaller::$helpBoxId = 1
protected

Numeric index of the help box.

Definition at line 132 of file WebInstaller.php.

◆ $otherPages

string [] WebInstaller::$otherPages
protected
Initial value:
= [
'Restart',
'Readme',
'ReleaseNotes',
'Copying',
'UpgradeDoc',
]

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

Definition at line 88 of file WebInstaller.php.

◆ $output

WebInstallerOutput WebInstaller::$output

Definition at line 37 of file WebInstaller.php.

◆ $pageSequence

string [] 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:

Definition at line 70 of file WebInstaller.php.

◆ $phpErrors

string [] WebInstaller::$phpErrors
protected

Captured PHP error text.

Temporary.

Definition at line 58 of file WebInstaller.php.

Referenced by getPhpErrors().

◆ $request

WebRequest WebInstaller::$request

WebRequest object.

Definition at line 44 of file WebInstaller.php.

Referenced by __construct().

◆ $session

array [] WebInstaller::$session
protected

Cached session array.

Definition at line 51 of file WebInstaller.php.

Referenced by execute(), and finish().

◆ $showSessionWarning

bool WebInstaller::$showSessionWarning = false

Flag indicating that session data may have been lost.

Definition at line 118 of file WebInstaller.php.

◆ $skippedPages

bool [] 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 111 of file WebInstaller.php.

Referenced by finish().

◆ $tabIndex

int WebInstaller::$tabIndex = 1
protected

Numeric index of the page we're on.

Definition at line 125 of file WebInstaller.php.


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