MediaWiki 1.41.2
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
WebInstallerPage Class Reference
Installer

Abstract class to define pages for the web installer. More...

Inherited by WebInstallerComplete, WebInstallerDBConnect, WebInstallerDBSettings, WebInstallerDocument, WebInstallerExistingWiki, WebInstallerInstall, WebInstallerLanguage, WebInstallerName, WebInstallerOptions, WebInstallerRestart, WebInstallerUpgrade, and WebInstallerWelcome.

Collaboration diagram for WebInstallerPage:
Collaboration graph
[legend]

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 32 of file WebInstallerPage.php.

Constructor & Destructor Documentation

◆ __construct()

WebInstallerPage::__construct ( WebInstaller $parent)
Parameters
WebInstaller$parent

Definition at line 49 of file WebInstallerPage.php.

References $parent.

Member Function Documentation

◆ addHTML()

WebInstallerPage::addHTML ( $html)
Parameters
string$html

Definition at line 67 of file WebInstallerPage.php.

Referenced by endForm(), endLiveBox(), WebInstallerInstall\endStage(), WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerDBSettings\execute(), WebInstallerExistingWiki\execute(), WebInstallerInstall\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerRestart\execute(), WebInstallerUpgrade\execute(), WebInstallerUpgrade\showDoneMessage(), WebInstallerExistingWiki\showKeyForm(), startForm(), startLiveBox(), and WebInstallerInstall\startStage().

◆ endForm()

WebInstallerPage::endForm ( $continue = 'continue',
$back = 'back' )
Parameters
string | bool$continue
string | bool$back

Definition at line 88 of file WebInstallerPage.php.

References addHTML(), getId(), and wfMessage().

Referenced by WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerDBSettings\execute(), WebInstallerDocument\execute(), WebInstallerExistingWiki\execute(), WebInstallerInstall\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerOptions\execute(), WebInstallerRestart\execute(), WebInstallerUpgrade\execute(), WebInstallerWelcome\execute(), WebInstallerUpgrade\showDoneMessage(), and WebInstallerExistingWiki\showKeyForm().

◆ endLiveBox()

WebInstallerPage::endLiveBox ( )
protected

Opposite to WebInstallerPage::startLiveBox.

Definition at line 203 of file WebInstallerPage.php.

References addHTML().

Referenced by WebInstallerInstall\endStage(), and WebInstallerUpgrade\execute().

◆ execute()

WebInstallerPage::execute ( )
abstract
Returns
string

Reimplemented in WebInstallerComplete, WebInstallerDBConnect, WebInstallerDBSettings, WebInstallerDocument, WebInstallerExistingWiki, WebInstallerInstall, WebInstallerLanguage, WebInstallerName, WebInstallerOptions, WebInstallerRestart, WebInstallerUpgrade, and WebInstallerWelcome.

◆ getFieldsetEnd()

WebInstallerPage::getFieldsetEnd ( )
protected

Get the end tag of a fieldset.

Returns
string

Definition at line 182 of file WebInstallerPage.php.

◆ getFieldsetStart()

WebInstallerPage::getFieldsetStart ( $legend)
protected

Get the starting tags of a fieldset.

Parameters
string$legendMessage name
Returns
string

Definition at line 173 of file WebInstallerPage.php.

References wfMessage().

◆ getId()

WebInstallerPage::getId ( )
protected
Returns
string

Definition at line 144 of file WebInstallerPage.php.

References getName().

Referenced by endForm().

◆ getName()

WebInstallerPage::getName ( )
Returns
string

Definition at line 137 of file WebInstallerPage.php.

Referenced by getId().

◆ getVar()

WebInstallerPage::getVar ( $var,
$default = null )
Parameters
string$var
mixed | null$default
Returns
mixed

Definition at line 154 of file WebInstallerPage.php.

Referenced by WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerDBSettings\execute(), WebInstallerExistingWiki\execute(), WebInstallerInstall\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerOptions\execute(), WebInstallerUpgrade\execute(), WebInstallerUpgrade\showDoneMessage(), and WebInstallerName\submit().

◆ isSlow()

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 WebInstallerInstall, and WebInstallerUpgrade.

Definition at line 60 of file WebInstallerPage.php.

◆ setVar()

WebInstallerPage::setVar ( $name,
$value )
Parameters
string$name
mixed$value

Definition at line 162 of file WebInstallerPage.php.

Referenced by WebInstallerDBConnect\execute(), WebInstallerExistingWiki\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerUpgrade\execute(), WebInstallerExistingWiki\handleExistingUpgrade(), WebInstallerExistingWiki\importVariables(), WebInstallerDBConnect\submit(), and WebInstallerName\submit().

◆ startForm()

WebInstallerPage::startForm ( )

Definition at line 71 of file WebInstallerPage.php.

References addHTML().

Referenced by WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerDBSettings\execute(), WebInstallerDocument\execute(), WebInstallerExistingWiki\execute(), WebInstallerInstall\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerOptions\execute(), WebInstallerRestart\execute(), WebInstallerUpgrade\execute(), WebInstallerWelcome\execute(), WebInstallerUpgrade\showDoneMessage(), and WebInstallerExistingWiki\showKeyForm().

◆ startLiveBox()

WebInstallerPage::startLiveBox ( )
protected

Opens a textarea used to display the progress of a long operation.

Definition at line 189 of file WebInstallerPage.php.

References addHTML().

Referenced by WebInstallerUpgrade\execute(), and WebInstallerInstall\startStage().

Member Data Documentation

◆ $parent

WebInstaller WebInstallerPage::$parent

The WebInstaller object this WebInstallerPage belongs to.

Definition at line 39 of file WebInstallerPage.php.

Referenced by __construct().

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