Class for setting up the MediaWiki database using MySQL. More...

Inheritance diagram for MysqlInstaller:

Collaboration diagram for MysqlInstaller:

[legend]

Public Member Functions
	canCreateAccounts ()
	Return true if the install user can create accounts.

	getCharsets ()
	Get a list of character sets that are available and supported.

	getConnectForm ()

	getEngines ()
	Get a list of storage engines that are available and supported.

	getLocalSettings ()
	Get the DBMS-specific options for LocalSettings.php generation.

	getName ()

	getSchemaVars ()
	Get variables to substitute into tables.sql and the SQL patch files.

	getSettingsForm ()

	isCompiled ()

	openConnection ()

	preInstall ()
	Allow DB installers a chance to make last-minute changes before installation occurs.

	preUpgrade ()
	Allow DB installers a chance to make checks before upgrade.

	setupDatabase ()

	setupUser ()

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

	submitSettingsForm ()

Public Member Functions inherited from DatabaseInstaller
	__construct ( $parent)
	Construct and initialise parent.

	checkPrerequisites ()
	Checks for installation prerequisites other than those checked by isCompiled()

	createExtensionTables ()
	Create the tables for each extension the user enabled.

	createManualTables ()
	Create database tables from scratch.

	createTables ()
	Create database tables from scratch from the automatically generated file.

	doUpgrade ()
	Perform database upgrades.

	enableLB ()
	Set up LBFactory so that wfGetDB() etc.

	getCheckBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled checkbox to configure a local boolean variable.

	getConnection ()
	Connect to the database using the administrative user/password currently defined in the session.

	getGeneratedSchemaPath ( $db)
	Return a path to the DBMS-specific automatically generated schema file.

	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals for the default values.

	getGlobalNames ()
	Get an array of MW configuration globals that will be configured by this class.

	getInstallUserBox ()
	Get a standard install-user fieldset.

	getInternalDefaults ()
	Get a name=>value map of internal variables used during installation.

	getPasswordBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled password box to configure a local variable.

	getRadioSet ( $params)
	Get a set of labelled radio buttons.

	getReadableName ()
	Get the internationalised name for this DBMS.

	getSchemaPath ( $db)
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql.

	getTextBox ( $var, $label, $attribs=[], $helpData="")
	Get a labelled text box to configure a local variable.

	getUpdateKeysPath ( $db)
	Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql.

	getVar ( $var, $default=null)
	Get a variable, taking local defaults into account.

	getWebUserBox ( $noCreateMsg=false)
	Get a standard web-user fieldset.

	insertUpdateKeys ()
	Insert update keys into table to prevent running unneeded updates.

	needsUpgrade ()
	Determine whether an existing installation of MediaWiki is present in the configured administrative connection.

	outputHandler ( $string)

	populateInterwikiTable ()
	Common function for databases that don't understand the MySQLish syntax of interwiki.list.

	setupSchemaVars ()
	Set appropriate schema variables in the current database connection.

	setVar ( $name, $value)
	Convenience alias for $this->parent->setVar()

	setVarsFromRequest ( $varNames)
	Convenience function to set variables based on form data.

	submitInstallUserBox ()
	Submit a standard install user fieldset.

	submitWebUserBox ()
	Submit the form from getWebUserBox().

Static Public Member Functions
static	meetsMinimumRequirement (IDatabase $conn)
	Whether the provided version meets the necessary requirements for this type.

Public Attributes
	$supportedEngines = [ 'InnoDB' ]

	$webUserPrivs

Public Attributes inherited from DatabaseInstaller
Database	$db = null
	The database connection.

WebInstaller	$parent
	The Installer object.

Static Public Attributes
static	$minimumVersion

Static Public Attributes inherited from DatabaseInstaller
static string	$minimumVersion
	Set by subclasses.

Protected Member Functions
	escapeLikeInternal ( $s, $escapeChar='`')

	getTableOptions ()
	Return any table options to be applied to all tables that don't override them.

	likeToRegex ( $wildcard)
	Convert a wildcard (as used in LIKE) to a regex Slashes are escaped, slash terminators included.

Protected Attributes
	$globalNames

	$internalDefaults

Protected Attributes inherited from DatabaseInstaller
array	$globalNames = []
	Array of MW configuration globals this class uses.

array	$internalDefaults = []
	Internal variables for installation.

Static Protected Attributes
static	$notMinimumVersionMessage

Static Protected Attributes inherited from DatabaseInstaller
static string	$notMinimumVersionMessage
	Set by subclasses.

Additional Inherited Members
Static Protected Member Functions inherited from DatabaseInstaller
static	checkExtension ( $name)
	Convenience function.

Detailed Description

Class for setting up the MediaWiki database using MySQL.

Since: 1.17

Definition at line 36 of file MysqlInstaller.php.

Member Function Documentation

◆ canCreateAccounts()

MysqlInstaller::canCreateAccounts ( )

Return true if the install user can create accounts.

Returns: bool

Definition at line 281 of file MysqlInstaller.php.

References $res, DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and likeToRegex().

Referenced by getSettingsForm(), and submitSettingsForm().

◆ escapeLikeInternal()

MysqlInstaller::escapeLikeInternal	(		$s,
			$escapeChar = '`' )

protected

Parameters

string	$s
string	$escapeChar

Returns: string

Definition at line 236 of file MysqlInstaller.php.

References $s.

Referenced by preUpgrade().

◆ getCharsets()

MysqlInstaller::getCharsets ( )

Get a list of character sets that are available and supported.

Returns: array

Definition at line 272 of file MysqlInstaller.php.

Referenced by getSettingsForm(), and submitSettingsForm().

◆ getConnectForm()

MysqlInstaller::getConnectForm ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 87 of file MysqlInstaller.php.

References DatabaseInstaller\getInstallUserBox(), DatabaseInstaller\getTextBox(), and wfMessage().

◆ getEngines()

MysqlInstaller::getEngines ( )

Get a list of storage engines that are available and supported.

Returns: array

Definition at line 247 of file MysqlInstaller.php.

References $res, and DatabaseInstaller\getConnection().

Referenced by getSettingsForm(), and submitSettingsForm().

◆ getLocalSettings()

MysqlInstaller::getLocalSettings ( )

Get the DBMS-specific options for LocalSettings.php generation.

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 645 of file MysqlInstaller.php.

References getTableOptions(), and DatabaseInstaller\getVar().

◆ getName()

MysqlInstaller::getName ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 73 of file MysqlInstaller.php.

◆ getSchemaVars()

MysqlInstaller::getSchemaVars ( )

Get variables to substitute into tables.sql and the SQL patch files.

Returns: array

Reimplemented from DatabaseInstaller.

Definition at line 636 of file MysqlInstaller.php.

References getTableOptions(), and DatabaseInstaller\getVar().

◆ getSettingsForm()

MysqlInstaller::getSettingsForm ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 368 of file MysqlInstaller.php.

References $s, canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getVar(), DatabaseInstaller\getWebUserBox(), and DatabaseInstaller\setVar().

◆ getTableOptions()

MysqlInstaller::getTableOptions ( )

protected

Return any table options to be applied to all tables that don't override them.

Returns: string

Definition at line 619 of file MysqlInstaller.php.

References DatabaseInstaller\getVar().

Referenced by getLocalSettings(), and getSchemaVars().

◆ isCompiled()

MysqlInstaller::isCompiled ( )

Returns: bool

Reimplemented from DatabaseInstaller.

Definition at line 80 of file MysqlInstaller.php.

References DatabaseInstaller\checkExtension().

◆ likeToRegex()

MysqlInstaller::likeToRegex ( $wildcard )

protected

Convert a wildcard (as used in LIKE) to a regex Slashes are escaped, slash terminators included.

Parameters

string $wildcard

Returns: string

Definition at line 356 of file MysqlInstaller.php.

Referenced by canCreateAccounts().

◆ meetsMinimumRequirement()

static MysqlInstaller::meetsMinimumRequirement ( IDatabase $conn )

static

Whether the provided version meets the necessary requirements for this type.

Parameters

IDatabase $conn

Returns: Status

Since: 1.30

Reimplemented from DatabaseInstaller.

Definition at line 146 of file MysqlInstaller.php.

References $type, and Wikimedia\Rdbms\IDatabase\getSoftwareLink().

◆ openConnection()

MysqlInstaller::openConnection ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 157 of file MysqlInstaller.php.

References DatabaseInstaller\$db, and DatabaseInstaller\getVar().

◆ preInstall()

MysqlInstaller::preInstall ( )

Allow DB installers a chance to make last-minute changes before installation occurs.

This happens before setupDatabase() or createTables() is called, but long after the constructor. Helpful for things like modifying setup steps :)

Stability: stable: to override

Reimplemented from DatabaseInstaller.

Definition at line 441 of file MysqlInstaller.php.

◆ preUpgrade()

MysqlInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Stability: stable: to override

Reimplemented from DatabaseInstaller.

Definition at line 176 of file MysqlInstaller.php.

References $res, $wgDBpassword, $wgDBuser, escapeLikeInternal(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and DatabaseInstaller\setVar().

◆ setupDatabase()

MysqlInstaller::setupDatabase ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 453 of file MysqlInstaller.php.

References DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and DatabaseInstaller\setupSchemaVars().

◆ setupUser()

MysqlInstaller::setupUser ( )

Returns: Status

Definition at line 490 of file MysqlInstaller.php.

References DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and DatabaseInstaller\setupSchemaVars().

◆ submitConnectForm()

MysqlInstaller::submitConnectForm ( )

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 from DatabaseInstaller.

Definition at line 104 of file MysqlInstaller.php.

References DatabaseInstaller\getConnection(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitInstallUserBox().

◆ submitSettingsForm()

MysqlInstaller::submitSettingsForm ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 395 of file MysqlInstaller.php.

References canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getVar(), DatabaseInstaller\setVar(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitWebUserBox().

Member Data Documentation

◆ $globalNames

MysqlInstaller::$globalNames

protected

Initial value:

= [
        'wgDBserver',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBprefix',
        'wgDBTableOptions',
    ]

Definition at line 38 of file MysqlInstaller.php.

◆ $internalDefaults

MysqlInstaller::$internalDefaults

protected

Initial value:

= [
        '_MysqlEngine' => 'InnoDB',
        '_MysqlCharset' => 'binary',
        '_InstallUser' => 'root',
    ]

Definition at line 47 of file MysqlInstaller.php.

◆ $minimumVersion

MysqlInstaller::$minimumVersion

static

Definition at line 59 of file MysqlInstaller.php.

◆ $notMinimumVersionMessage

MysqlInstaller::$notMinimumVersionMessage

staticprotected

Definition at line 60 of file MysqlInstaller.php.

◆ $supportedEngines

MysqlInstaller::$supportedEngines = [ 'InnoDB' ]

Definition at line 53 of file MysqlInstaller.php.

◆ $webUserPrivs

MysqlInstaller::$webUserPrivs

Initial value:

= [
        'DELETE',
        'INSERT',
        'SELECT',
        'UPDATE',
        'CREATE TEMPORARY TABLES',
    ]

Definition at line 62 of file MysqlInstaller.php.

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

includes/installer/MysqlInstaller.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canCreateAccounts()

◆ escapeLikeInternal()

◆ getCharsets()

◆ getConnectForm()

◆ getEngines()

◆ getLocalSettings()

◆ getName()

◆ getSchemaVars()

◆ getSettingsForm()

◆ getTableOptions()

◆ isCompiled()

◆ likeToRegex()

◆ meetsMinimumRequirement()

◆ openConnection()

◆ preInstall()

◆ preUpgrade()

◆ setupDatabase()

◆ setupUser()

◆ submitConnectForm()

◆ submitSettingsForm()

Member Data Documentation

◆ $globalNames

◆ $internalDefaults

◆ $minimumVersion

◆ $notMinimumVersionMessage

◆ $supportedEngines

◆ $webUserPrivs