MediaWiki master
MediaWiki\Installer\DatabaseConnectForm Class Reference

Inherits MediaWiki\Installer\DatabaseForm.

Inherited by MediaWiki\Installer\MysqlConnectForm, MediaWiki\Installer\PostgresConnectForm, and MediaWiki\Installer\SqliteConnectForm.

Collaboration diagram for MediaWiki\Installer\DatabaseConnectForm:

Public Member Functions

 getHtml ()
 Get HTML for a web form that configures this database.
 
 submit ()
 Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm().
 
- Public Member Functions inherited from MediaWiki\Installer\DatabaseForm
 __construct (WebInstaller $webInstaller, DatabaseInstaller $dbInstaller)
 

Protected Member Functions

 getInstallUserBox ()
 Get a standard install-user fieldset.
 
 submitInstallUserBox ()
 Submit a standard install 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 DatabaseConnectForm.php.

Member Function Documentation

◆ getHtml()

MediaWiki\Installer\DatabaseConnectForm::getHtml ( )
abstract

Get HTML for a web form that configures this database.

Configuration at this time should be the minimum needed to connect and test whether install or upgrade is required.

If this is called, $this->parent can be assumed to be a WebInstaller.

Reimplemented in MediaWiki\Installer\MysqlConnectForm, MediaWiki\Installer\PostgresConnectForm, and MediaWiki\Installer\SqliteConnectForm.

◆ getInstallUserBox()

MediaWiki\Installer\DatabaseConnectForm::getInstallUserBox ( )
protected

◆ submit()

MediaWiki\Installer\DatabaseConnectForm::submit ( )
abstract

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

Validate the connection settings by attempting to connect with them.

If this is called, $this->parent can be assumed to be a WebInstaller.

Returns
Status

Reimplemented in MediaWiki\Installer\MysqlConnectForm, MediaWiki\Installer\PostgresConnectForm, and MediaWiki\Installer\SqliteConnectForm.

◆ submitInstallUserBox()

MediaWiki\Installer\DatabaseConnectForm::submitInstallUserBox ( )
protected

Submit a standard install user fieldset.

Returns
Status

Definition at line 65 of file DatabaseConnectForm.php.

References MediaWiki\Installer\DatabaseForm\setVarsFromRequest().

Referenced by MediaWiki\Installer\MysqlConnectForm\submit(), and MediaWiki\Installer\PostgresConnectForm\submit().


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