| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Core installer web interface. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| File Size: | 1210 lines (31 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WebInstaller:: (42 methods):
__construct()
execute()
getLowestUnhappy()
startSession()
getFingerprint()
showError()
errorHandler()
finish()
reset()
getUrl()
getPageByName()
getSession()
setSession()
nextTabIndex()
setupLanguage()
getAcceptLanguage()
startPageWrapper()
getPageListItem()
endPageWrapper()
getErrorBox()
getWarningBox()
getInfoBox()
getHelpBox()
showHelpBox()
showMessage()
showStatusMessage()
label()
getTextBox()
getTextArea()
getPasswordBox()
getCheckBox()
getRadioSet()
getRadioElements()
showStatusBox()
setVarsFromRequest()
getDocUrl()
docLink()
downloadLinkHook()
envCheckPath()
envGetDefaultServer()
outputCss()
getPhpErrors()
Class: WebInstaller - X-Ref
Class for the core installer web interface.| __construct( WebRequest $request ) X-Ref |
| Constructor. param: WebRequest $request |
| execute( array $session ) X-Ref |
| Main entry point. param: array[] $session Initial session array return: array[] New session array |
| getLowestUnhappy() X-Ref |
| Find the next page in sequence that hasn't been completed return: int |
| startSession() X-Ref |
| Start the PHP session. This may be called before execute() to start the PHP session. return: bool |
| getFingerprint() X-Ref |
| 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. return: string |
| showError( $msg ) X-Ref |
| Show an error message in a box. Parameters are like wfMessage(). param: string $msg |
| errorHandler( $errno, $errstr ) X-Ref |
| Temporary error handler for session start debugging. param: int $errno Unused param: string $errstr |
| finish() X-Ref |
| Clean up from execute() return: array[] |
| reset() X-Ref |
| We're restarting the installation, reset the session, happyPages, etc |
| getUrl( $query = array() X-Ref |
| Get a URL for submission back to the same script. param: string[] $query return: string |
| getPageByName( $pageName ) X-Ref |
| Get a WebInstallerPage by name. param: string $pageName return: WebInstallerPage |
| getSession( $name, $default = null ) X-Ref |
| Get a session variable. param: string $name param: array $default return: array |
| setSession( $name, $value ) X-Ref |
| Set a session variable. param: string $name Key for the variable param: mixed $value |
| nextTabIndex() X-Ref |
| Get the next tabindex attribute value. return: int |
| setupLanguage() X-Ref |
| Initializes language-related variables. |
| getAcceptLanguage() X-Ref |
| Retrieves MediaWiki language from Accept-Language HTTP header. return: string |
| startPageWrapper( $currentPageName ) X-Ref |
| Called by execute() before page output starts, to show a page list. param: string $currentPageName |
| getPageListItem( $pageName, $enabled, $currentPageName ) X-Ref |
| Get a list item for the page list. param: string $pageName param: bool $enabled param: string $currentPageName return: string |
| endPageWrapper() X-Ref |
| Output some stuff after a page is finished. |
| getErrorBox( $text ) X-Ref |
| Get HTML for an error box with an icon. param: string $text Wikitext, get this with wfMessage()->plain() return: string |
| getWarningBox( $text ) X-Ref |
| Get HTML for a warning box with an icon. param: string $text Wikitext, get this with wfMessage()->plain() return: string |
| getInfoBox( $text, $icon = false, $class = false ) X-Ref |
| Get HTML for an info box with an icon. param: string $text Wikitext, get this with wfMessage()->plain() param: string|bool $icon Icon name, file in mw-config/images. Default: false param: string|bool $class Additional class name to add to the wrapper div. Default: false. return: string |
| getHelpBox( $msg ) X-Ref |
| Get small text indented help for a preceding form field. Parameters like wfMessage(). param: string $msg return: string |
| showHelpBox( $msg ) X-Ref |
| Output a help box. param: string $msg Key for wfMessage() |
| showMessage( $msg ) X-Ref |
| Show a short informational message. Output looks like a list. param: string $msg |
| showStatusMessage( Status $status ) X-Ref |
param: Status $status |
| label( $msg, $forId, $contents, $helpData = "" ) X-Ref |
| Label a control by wrapping a config-input div around it and putting a label before it. param: string $msg param: string $forId param: string $contents param: string $helpData return: string |
| getTextBox( $params ) X-Ref |
| Get a labelled text box to configure a variable. param: mixed[] $params return: string |
| getTextArea( $params ) X-Ref |
| Get a labelled textarea to configure a variable param: mixed[] $params return: string |
| getPasswordBox( $params ) X-Ref |
| Get a labelled password box to configure a variable. Implements password hiding param: mixed[] $params return: string |
| getCheckBox( $params ) X-Ref |
| Get a labelled checkbox to configure a boolean variable. param: mixed[] $params return: string |
| getRadioSet( $params ) X-Ref |
| Get a set of labelled radio buttons. param: mixed[] $params return: string |
| getRadioElements( $params ) X-Ref |
| Get a set of labelled radio buttons. You probably want to use getRadioSet(), not this. return: array |
| showStatusBox( $status ) X-Ref |
| Output an error or warning box using a Status object. param: Status $status |
| setVarsFromRequest( $varNames, $prefix = 'config_' ) X-Ref |
| Convenience function to set variables based on form data. Assumes that variables containing "password" in the name are (potentially fake) passwords. param: string[] $varNames param: string $prefix The prefix added to variables to obtain form names return: string[] |
| getDocUrl( $page ) X-Ref |
| Helper for Installer::docLink() param: string $page return: string |
| docLink( $linkText, $attribs, $parser ) X-Ref |
| Extension tag hook for a documentation link. param: string $linkText param: string[] $attribs param: Parser $parser Unused return: string |
| downloadLinkHook( $text, $attribs, $parser ) X-Ref |
| Helper for "Download LocalSettings" link on WebInstall_Complete param: string $text Unused param: string[] $attribs Unused param: Parser $parser Unused return: string Html for download link |
| envCheckPath() X-Ref |
return: bool |
| envGetDefaultServer() X-Ref |
return: string |
| outputCss() X-Ref |
| Output stylesheet for web installer pages |
| getPhpErrors() X-Ref |
return: string[] |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |