WebInstallerPage Class Reference

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

Inheritance diagram for WebInstallerPage:

Collaboration diagram for WebInstallerPage:

List of all members.

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

---

Constructor & Destructor Documentation

WebInstallerPage::__construct

(

WebInstaller $

parent

)

Parameters:

WebInstaller

$parent

Definition at line 46 of file WebInstallerPage.php.

---

Member Function Documentation

WebInstallerPage::addHTML

(

$

html

)

Parameters:

string

$html

Definition at line 64 of file WebInstallerPage.php.

Referenced by WebInstallerComplete\execute(), WebInstallerUpgrade\showDoneMessage(), startForm(), and WebInstallerOptions\submitCC().

WebInstallerPage::endForm	(	$	continue = 'continue',
		$	back = 'back'
	)

Parameters:

string | bool	$continue
string | bool	$back

Definition at line 85 of file WebInstallerPage.php.

Referenced by WebInstallerComplete\execute(), WebInstallerDocument\execute(), and WebInstallerUpgrade\showDoneMessage().

WebInstallerPage::endLiveBox

(

)

[protected]

Opposite to WebInstallerPage::startLiveBox.

Definition at line 200 of file WebInstallerPage.php.

WebInstallerPage::execute

(

)

[abstract]

Returns:

string

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

WebInstallerPage::getFieldsetEnd

(

)

[protected]

Get the end tag of a fieldset.

Returns:

string

Definition at line 179 of file WebInstallerPage.php.

WebInstallerPage::getFieldsetStart

(

$

legend

)

[protected]

Get the starting tags of a fieldset.

Parameters:

string

$legend

Message name

Returns:

string

Definition at line 170 of file WebInstallerPage.php.

WebInstallerPage::getId

(

)

[protected]

Returns:

string

Definition at line 141 of file WebInstallerPage.php.

WebInstallerPage::getName

(

)

Returns:

string

Definition at line 134 of file WebInstallerPage.php.

Referenced by startForm().

WebInstallerPage::getVar	(	$	var,
		$	default = null
	)

Parameters:

string	$var
mixed	$default

Returns:

mixed

Definition at line 151 of file WebInstallerPage.php.

Referenced by WebInstallerComplete\execute(), and WebInstallerUpgrade\showDoneMessage().

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

WebInstallerPage::setVar	(	$	name,
		$	value
	)

Parameters:

string	$name
mixed	$value

Definition at line 159 of file WebInstallerPage.php.

Referenced by WebInstallerOptions\submitCC().

WebInstallerPage::startForm

(

)

Definition at line 68 of file WebInstallerPage.php.

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

Referenced by WebInstallerComplete\execute(), WebInstallerDocument\execute(), and WebInstallerUpgrade\showDoneMessage().

WebInstallerPage::startLiveBox

(

)

[protected]

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

Definition at line 186 of file WebInstallerPage.php.

---

Member Data Documentation

WebInstaller WebInstallerPage::$parent

The WebInstaller object this WebInstallerPage belongs to.

Definition at line 36 of file WebInstallerPage.php.

---

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

• includes/installer/WebInstallerPage.php