MediaWiki master
MediaWiki\Installer\DatabaseSettingsForm Class Reference

Inherits MediaWiki\Installer\DatabaseForm.

Inherited by MediaWiki\Installer\MysqlSettingsForm, and MediaWiki\Installer\PostgresSettingsForm.

Collaboration diagram for MediaWiki\Installer\DatabaseSettingsForm:

Public Member Functions

 getHtml ()
 Get HTML for a web form that retrieves settings used for installation.
 
 submit ()
 Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().
 
 submitWebUserBox ()
 Submit the form from getWebUserBox().
 
- Public Member Functions inherited from MediaWiki\Installer\DatabaseForm
 __construct (WebInstaller $webInstaller, DatabaseInstaller $dbInstaller)
 

Protected Member Functions

 getWebUserBox ( $noCreateMsg=false)
 Get a standard web-user fieldset.
 
- Protected Member Functions inherited from MediaWiki\Installer\DatabaseForm
 getCheckBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled checkbox to configure a local boolean variable.
 
 getName ()
 Return the internal name, e.g.
 
 getPasswordBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled password box to configure a local variable.
 
 getRadioSet ( $params)
 Get a set of labelled radio buttons.
 
 getTextBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled text box to configure a local variable.
 
 getVar ( $var, $default=null)
 Get a variable, taking local defaults into account.
 
 setVar ( $name, $value)
 Set a variable.
 
 setVarsFromRequest ( $varNames)
 Convenience function to set variables based on form data.
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Installer\DatabaseForm
DatabaseInstaller $dbInstaller
 
WebInstaller $webInstaller
 

Detailed Description

Access: internal

Definition at line 11 of file DatabaseSettingsForm.php.

Member Function Documentation

◆ getHtml()

MediaWiki\Installer\DatabaseSettingsForm::getHtml ( )

Get HTML for a web form that retrieves settings used for installation.

$this->parent can be assumed to be a WebInstaller. If the DB type has no settings beyond those already configured with getConnectForm(), this should return false.

Returns
string|false

Reimplemented in MediaWiki\Installer\MysqlSettingsForm, and MediaWiki\Installer\PostgresSettingsForm.

Definition at line 20 of file DatabaseSettingsForm.php.

◆ getWebUserBox()

MediaWiki\Installer\DatabaseSettingsForm::getWebUserBox ( $noCreateMsg = false)
protected

Get a standard web-user fieldset.

Parameters
string | false$noCreateMsgMessage to display instead of the creation checkbox. Set this to false to show a creation checkbox (default).
Returns
string

Definition at line 41 of file DatabaseSettingsForm.php.

References MediaWiki\Html\element(), MediaWiki\Installer\DatabaseForm\getCheckBox(), MediaWiki\Installer\DatabaseForm\getPasswordBox(), MediaWiki\Installer\DatabaseForm\getTextBox(), MediaWiki\Installer\DatabaseForm\getVar(), and wfMessage().

Referenced by MediaWiki\Installer\MysqlSettingsForm\getHtml(), and MediaWiki\Installer\PostgresSettingsForm\getHtml().

◆ submit()

MediaWiki\Installer\DatabaseSettingsForm::submit ( )

Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().

Returns
Status

Reimplemented in MediaWiki\Installer\MysqlSettingsForm, and MediaWiki\Installer\PostgresSettingsForm.

Definition at line 30 of file DatabaseSettingsForm.php.

◆ submitWebUserBox()

MediaWiki\Installer\DatabaseSettingsForm::submitWebUserBox ( )

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