MediaWiki\Installer\WebInstallerPage Class Reference

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.

Collaboration diagram for MediaWiki\Installer\WebInstallerPage:

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 ()
	inlineScript ( $script)
	Javascript to include inline.
	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 19 of file WebInstallerPage.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Installer\WebInstallerPage::__construct

(

WebInstaller

$parent

)

Definition at line 33 of file WebInstallerPage.php.

References MediaWiki\Installer\WebInstallerPage\$parent.

Member Function Documentation

addHTML()

MediaWiki\Installer\WebInstallerPage::addHTML

(

$html

)

Parameters

string

$html

Definition at line 51 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\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 72 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()

MediaWiki\Installer\WebInstallerPage::endLiveBox ( )

protected

Opposite to WebInstallerPage::startLiveBox.

Definition at line 190 of file WebInstallerPage.php.

References MediaWiki\Installer\WebInstallerPage\addHTML(), and MediaWiki\Installer\WebInstallerPage\inlineScript().

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

execute()

MediaWiki\Installer\WebInstallerPage::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()

MediaWiki\Installer\WebInstallerPage::getFieldsetEnd ( )

protected

Get the end tag of a fieldset.

Returns

string

Definition at line 169 of file WebInstallerPage.php.

getFieldsetStart()

MediaWiki\Installer\WebInstallerPage::getFieldsetStart ( $legend )

protected

Get the starting tags of a fieldset.

Parameters

string

$legend

Message name

Returns

string

Definition at line 159 of file WebInstallerPage.php.

References wfMessage().

getId()

MediaWiki\Installer\WebInstallerPage::getId ( )

protected

Returns

string

Definition at line 130 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 123 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 140 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().

inlineScript()

MediaWiki\Installer\WebInstallerPage::inlineScript ( $script )

protected

Javascript to include inline.

Handles addings CSP nonce.

Since

1.45

Parameters

string

$script

Script, not including <script> tag

Returns

string HTML to output

Definition at line 205 of file WebInstallerPage.php.

Referenced by MediaWiki\Installer\WebInstallerPage\endLiveBox(), and MediaWiki\Installer\WebInstallerPage\startLiveBox().

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

setVar()

MediaWiki\Installer\WebInstallerPage::setVar	(		$name,
			$value )

Parameters

string	$name
mixed	$value

Definition at line 148 of file WebInstallerPage.php.

Referenced by MediaWiki\Installer\WebInstallerDBConnect\execute(), MediaWiki\Installer\WebInstallerExistingWiki\execute(), MediaWiki\Installer\WebInstallerLanguage\execute(), MediaWiki\Installer\WebInstallerName\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 55 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()

MediaWiki\Installer\WebInstallerPage::startLiveBox ( )

protected

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

Definition at line 176 of file WebInstallerPage.php.

References MediaWiki\Installer\WebInstallerPage\addHTML(), and MediaWiki\Installer\WebInstallerPage\inlineScript().

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 26 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