Abstract class to define pages for the web installer. More...
Inherited by MediaWiki\Installer\WebInstallerComplete, MediaWiki\Installer\WebInstallerDBConnect, MediaWiki\Installer\WebInstallerDBSettings, MediaWiki\Installer\WebInstallerDocument, MediaWiki\Installer\WebInstallerExistingWiki, MediaWiki\Installer\WebInstallerInstall, MediaWiki\Installer\WebInstallerLanguage, MediaWiki\Installer\WebInstallerName, MediaWiki\Installer\WebInstallerOptions, MediaWiki\Installer\WebInstallerRestart, MediaWiki\Installer\WebInstallerUpgrade, and MediaWiki\Installer\WebInstallerWelcome.
Public Member Functions | |
| __construct (WebInstaller $parent) | |
| addHTML ( $html) | |
| endForm ( $continue='continue', $back='back') | |
| execute () | |
| getName () | |
| getVar ( $var, $default=null) | |
| isSlow () | |
| Is this a slow-running page in the installer? If so, WebInstaller will set_time_limit(0) before calling execute(). | |
| setVar ( $name, $value) | |
| startForm () | |
Public Attributes | |
| WebInstaller | $parent |
| The WebInstaller object this WebInstallerPage belongs to. | |
Protected Member Functions | |
| endLiveBox () | |
| Opposite to WebInstallerPage::startLiveBox. | |
| getFieldsetEnd () | |
| Get the end tag of a fieldset. | |
| getFieldsetStart ( $legend) | |
| Get the starting tags of a fieldset. | |
| getId () | |
| startLiveBox () | |
| Opens a textarea used to display the progress of a long operation. | |
Detailed Description
Abstract class to define pages for the web installer.
- Since
- 1.17
Definition at line 34 of file WebInstallerPage.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Installer\WebInstallerPage::__construct | ( | WebInstaller | $parent | ) |
- Parameters
-
WebInstaller $parent
Definition at line 51 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\$parent.
Member Function Documentation
◆ addHTML()
| MediaWiki\Installer\WebInstallerPage::addHTML | ( | $html | ) |
- Parameters
-
string $html
Definition at line 69 of file WebInstallerPage.php.
Referenced by MediaWiki\Installer\WebInstallerPage\endForm(), MediaWiki\Installer\WebInstallerPage\endLiveBox(), MediaWiki\Installer\WebInstallerInstall\endStage(), MediaWiki\Installer\WebInstallerComplete\execute(), MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerDBSettings\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerInstall\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\execute(), MediaWiki\Installer\WebInstallerRestart\execute(), MediaWiki\Installer\WebInstallerUpgrade\execute(), MediaWiki\Installer\WebInstallerUpgrade\showDoneMessage(), MediaWiki\Installer\WebInstallerExistingWiki\showKeyForm(), MediaWiki\Installer\WebInstallerPage\startForm(), MediaWiki\Installer\WebInstallerPage\startLiveBox(), and MediaWiki\Installer\WebInstallerInstall\startStage().
◆ endForm()
| MediaWiki\Installer\WebInstallerPage::endForm | ( | $continue = 'continue', | |
| $back = 'back' ) |
- Parameters
-
string | bool $continue string | bool $back
Definition at line 90 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\addHTML(), MediaWiki\Installer\WebInstallerPage\getId(), and wfMessage().
Referenced by MediaWiki\Installer\WebInstallerComplete\execute(), MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerDBSettings\execute(), MediaWiki\Installer\WebInstallerDocument\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerInstall\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\execute(), MediaWiki\Installer\WebInstallerOptions\execute(), MediaWiki\Installer\WebInstallerRestart\execute(), MediaWiki\Installer\WebInstallerUpgrade\execute(), MediaWiki\Installer\WebInstallerWelcome\execute(), MediaWiki\Installer\WebInstallerUpgrade\showDoneMessage(), and MediaWiki\Installer\WebInstallerExistingWiki\showKeyForm().
◆ endLiveBox()
|
protected |
Opposite to WebInstallerPage::startLiveBox.
Definition at line 208 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\addHTML().
Referenced by MediaWiki\Installer\WebInstallerInstall\endStage(), and MediaWiki\Installer\WebInstallerUpgrade\execute().
◆ execute()
|
abstract |
- Returns
- string
Reimplemented in MediaWiki\Installer\WebInstallerComplete, MediaWiki\Installer\WebInstallerDBConnect, MediaWiki\Installer\WebInstallerDBSettings, MediaWiki\Installer\WebInstallerDocument, MediaWiki\Installer\WebInstallerExistingWiki, MediaWiki\Installer\WebInstallerInstall, MediaWiki\Installer\WebInstallerLanguage, MediaWiki\Installer\WebInstallerName, MediaWiki\Installer\WebInstallerOptions, MediaWiki\Installer\WebInstallerRestart, MediaWiki\Installer\WebInstallerUpgrade, and MediaWiki\Installer\WebInstallerWelcome.
◆ getFieldsetEnd()
|
protected |
◆ getFieldsetStart()
|
protected |
Get the starting tags of a fieldset.
- Parameters
-
string $legend Message name
- Returns
- string
Definition at line 177 of file WebInstallerPage.php.
References wfMessage().
◆ getId()
|
protected |
- Returns
- string
Definition at line 148 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\getName().
Referenced by MediaWiki\Installer\WebInstallerPage\endForm().
◆ getName()
| MediaWiki\Installer\WebInstallerPage::getName | ( | ) |
- Returns
- string
Definition at line 141 of file WebInstallerPage.php.
Referenced by MediaWiki\Installer\WebInstallerPage\getId().
◆ getVar()
| MediaWiki\Installer\WebInstallerPage::getVar | ( | $var, | |
| $default = null ) |
- Parameters
-
string $var mixed | null $default
- Returns
- mixed
Definition at line 158 of file WebInstallerPage.php.
Referenced by MediaWiki\Installer\WebInstallerComplete\execute(), MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerDBSettings\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerInstall\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\execute(), MediaWiki\Installer\WebInstallerOptions\execute(), MediaWiki\Installer\WebInstallerUpgrade\execute(), MediaWiki\Installer\WebInstallerUpgrade\showDoneMessage(), and MediaWiki\Installer\WebInstallerName\submit().
◆ isSlow()
| MediaWiki\Installer\WebInstallerPage::isSlow | ( | ) |
Is this a slow-running page in the installer? If so, WebInstaller will set_time_limit(0) before calling execute().
Right now this only applies to Install and Upgrade pages
- Returns
- bool Always false in this default implementation.
Reimplemented in MediaWiki\Installer\WebInstallerInstall, and MediaWiki\Installer\WebInstallerUpgrade.
Definition at line 62 of file WebInstallerPage.php.
◆ setVar()
| MediaWiki\Installer\WebInstallerPage::setVar | ( | $name, | |
| $value ) |
- Parameters
-
string $name mixed $value
Definition at line 166 of file WebInstallerPage.php.
Referenced by MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\execute(), MediaWiki\Installer\WebInstallerUpgrade\execute(), MediaWiki\Installer\WebInstallerExistingWiki\handleExistingUpgrade(), MediaWiki\Installer\WebInstallerExistingWiki\importVariables(), MediaWiki\Installer\WebInstallerDBConnect\submit(), and MediaWiki\Installer\WebInstallerName\submit().
◆ startForm()
| MediaWiki\Installer\WebInstallerPage::startForm | ( | ) |
Definition at line 73 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\addHTML().
Referenced by MediaWiki\Installer\WebInstallerComplete\execute(), MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerDBSettings\execute(), MediaWiki\Installer\WebInstallerDocument\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerInstall\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\execute(), MediaWiki\Installer\WebInstallerOptions\execute(), MediaWiki\Installer\WebInstallerRestart\execute(), MediaWiki\Installer\WebInstallerUpgrade\execute(), MediaWiki\Installer\WebInstallerWelcome\execute(), MediaWiki\Installer\WebInstallerUpgrade\showDoneMessage(), and MediaWiki\Installer\WebInstallerExistingWiki\showKeyForm().
◆ startLiveBox()
|
protected |
Opens a textarea used to display the progress of a long operation.
Definition at line 194 of file WebInstallerPage.php.
References MediaWiki\Installer\WebInstallerPage\addHTML().
Referenced by MediaWiki\Installer\WebInstallerUpgrade\execute(), and MediaWiki\Installer\WebInstallerInstall\startStage().
Member Data Documentation
◆ $parent
| WebInstaller MediaWiki\Installer\WebInstallerPage::$parent |
The WebInstaller object this WebInstallerPage belongs to.
Definition at line 41 of file WebInstallerPage.php.
Referenced by MediaWiki\Installer\WebInstallerPage\__construct().
The documentation for this class was generated from the following file:
- includes/installer/WebInstallerPage.php
