MediaWiki  1.34.4
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
WebInstallerPage Class Reference
Deployment

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

Inheritance diagram for WebInstallerPage:
Inheritance graph
[legend]
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(). More...
 
 setVar ( $name, $value)
 
 startForm ()
 

Public Attributes

WebInstaller $parent
 The WebInstaller object this WebInstallerPage belongs to. More...
 

Protected Member Functions

 endLiveBox ()
 Opposite to WebInstallerPage::startLiveBox. More...
 
 getFieldsetEnd ()
 Get the end tag of a fieldset. More...
 
 getFieldsetStart ( $legend)
 Get the starting tags of a fieldset. More...
 
 getId ()
 
 startLiveBox ()
 Opens a textarea used to display the progress of a long operation. More...
 

Detailed Description

Abstract class to define pages for the web installer.

Since
1.17

Definition at line 30 of file WebInstallerPage.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 47 of file WebInstallerPage.php.

References $parent.

Member Function Documentation

◆ addHTML()

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

Definition at line 65 of file WebInstallerPage.php.

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

◆ endForm()

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

Definition at line 86 of file WebInstallerPage.php.

References $s, addHTML(), getId(), Html\hidden(), Xml\submitButton(), and wfMessage().

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

◆ endLiveBox()

WebInstallerPage::endLiveBox ( )
protected

Opposite to WebInstallerPage::startLiveBox.

Definition at line 201 of file WebInstallerPage.php.

References addHTML().

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

◆ execute()

WebInstallerPage::execute ( )
abstract
Returns
string

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

◆ getFieldsetEnd()

WebInstallerPage::getFieldsetEnd ( )
protected

Get the end tag of a fieldset.

Returns
string

Definition at line 180 of file WebInstallerPage.php.

Referenced by WebInstallerOptions\execute().

◆ getFieldsetStart()

WebInstallerPage::getFieldsetStart (   $legend)
protected

Get the starting tags of a fieldset.

Parameters
string$legendMessage name
Returns
string

Definition at line 171 of file WebInstallerPage.php.

References wfMessage().

Referenced by WebInstallerOptions\execute().

◆ getId()

WebInstallerPage::getId ( )
protected
Returns
string

Definition at line 142 of file WebInstallerPage.php.

References getName().

Referenced by endForm().

◆ getName()

WebInstallerPage::getName ( )
Returns
string

Definition at line 135 of file WebInstallerPage.php.

Referenced by getId().

◆ getVar()

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

Definition at line 152 of file WebInstallerPage.php.

Referenced by WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerExistingWiki\execute(), WebInstallerOptions\execute(), WebInstallerDBSettings\execute(), WebInstallerLanguage\execute(), WebInstallerName\execute(), WebInstallerUpgrade\execute(), WebInstallerInstall\execute(), WebInstallerOptions\getCCChooser(), WebInstallerOptions\getCCDoneBox(), WebInstallerOptions\getCCPartnerUrl(), WebInstallerUpgrade\showDoneMessage(), WebInstallerName\submit(), and WebInstallerOptions\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 58 of file WebInstallerPage.php.

◆ setVar()

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

Definition at line 160 of file WebInstallerPage.php.

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

◆ startForm()

WebInstallerPage::startForm ( )

Definition at line 69 of file WebInstallerPage.php.

References addHTML(), and Html\openElement().

Referenced by WebInstallerComplete\execute(), WebInstallerDBConnect\execute(), WebInstallerLanguage\execute(), WebInstallerExistingWiki\execute(), WebInstallerOptions\execute(), WebInstallerRestart\execute(), WebInstallerDBSettings\execute(), WebInstallerWelcome\execute(), WebInstallerDocument\execute(), WebInstallerName\execute(), WebInstallerUpgrade\execute(), WebInstallerInstall\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 187 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 37 of file WebInstallerPage.php.

Referenced by __construct().

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