MediaWiki  REL1_22
MysqlInstaller Class Reference

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

Inheritance diagram for MysqlInstaller:
Collaboration diagram for MysqlInstaller:

List of all members.

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.
 getGlobalDefaults ()
 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 Attributes

 $minimumVersion = '5.0.2'
 $supportedEngines = array( 'InnoDB', 'MyISAM' )
 $webUserPrivs

Protected Member Functions

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

Protected Attributes

 $globalNames
 Array of MW configuration globals this class uses.
 $internalDefaults
 Internal variables for installation.

Private Member Functions

 buildFullUserName ($name, $host)
 Return a formal 'User'@'Host' username for use in queries.
 userDefinitelyExists ($host, $user)
 Try to see if the user account exists.

Detailed Description

Class for setting up the MediaWiki database using MySQL.

Since:
1.17

Definition at line 30 of file MysqlInstaller.php.


Member Function Documentation

MysqlInstaller::buildFullUserName ( name,
host 
) [private]

Return a formal 'User'@'Host' username for use in queries.

Parameters:
string$nameUsername, quotes will be added
string$hostHostname, quotes will be added
Returns:
String

Definition at line 599 of file MysqlInstaller.php.

References $name.

Referenced by setupUser().

Return true if the install user can create accounts.

Returns:
bool

Definition at line 266 of file MysqlInstaller.php.

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

Referenced by getSettingsForm(), and submitSettingsForm().

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

Returns:
array

Definition at line 257 of file MysqlInstaller.php.

References array().

Referenced by getSettingsForm(), and submitSettingsForm().

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

Returns:
array

Definition at line 232 of file MysqlInstaller.php.

References $res, array(), as, and DatabaseInstaller\getConnection().

Referenced by getSettingsForm(), and submitSettingsForm().

Returns:
array

Reimplemented from DatabaseInstaller.

Definition at line 77 of file MysqlInstaller.php.

References array().

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

Returns:
String

Reimplemented from DatabaseInstaller.

Definition at line 653 of file MysqlInstaller.php.

References LocalSettingsGenerator\escapePhpString(), getTableOptions(), DatabaseInstaller\getVar(), and wfBoolToStr().

Returns:
string

Reimplemented from DatabaseInstaller.

Definition at line 63 of file MysqlInstaller.php.

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

Returns:
array

Reimplemented from DatabaseInstaller.

Definition at line 644 of file MysqlInstaller.php.

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

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

Returns:
String

Definition at line 627 of file MysqlInstaller.php.

References $options, array(), and DatabaseInstaller\getVar().

Referenced by getLocalSettings(), and getSchemaVars().

Returns:
Bool

Reimplemented from DatabaseInstaller.

Definition at line 70 of file MysqlInstaller.php.

References DatabaseInstaller\checkExtension().

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 :)

Reimplemented from DatabaseInstaller.

Definition at line 465 of file MysqlInstaller.php.

References array().

Allow DB installers a chance to make checks before upgrade.

Reimplemented from DatabaseInstaller.

Definition at line 168 of file MysqlInstaller.php.

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

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 101 of file MysqlInstaller.php.

References array(), DatabaseInstaller\getConnection(), Status\newFatal(), Status\newGood(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitInstallUserBox().

MysqlInstaller::userDefinitelyExists ( host,
user 
) [private]

Try to see if the user account exists.

Our "superuser" may not have access to mysql.user, so false means "no" or "maybe"

Parameters:
string$hostHostname to check
string$userUsername to check
Returns:
boolean

Definition at line 610 of file MysqlInstaller.php.

References $res, $user, and array().

Referenced by setupUser().


Member Data Documentation

MysqlInstaller::$globalNames [protected]
Initial value:
 array(
        'wgDBserver',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBprefix',
        'wgDBTableOptions',
        'wgDBmysql5',
    )

Array of MW configuration globals this class uses.

Reimplemented from DatabaseInstaller.

Definition at line 32 of file MysqlInstaller.php.

MysqlInstaller::$internalDefaults [protected]
Initial value:
 array(
        '_MysqlEngine' => 'InnoDB',
        '_MysqlCharset' => 'binary',
        '_InstallUser' => 'root',
    )

Internal variables for installation.

Reimplemented from DatabaseInstaller.

Definition at line 42 of file MysqlInstaller.php.

MysqlInstaller::$minimumVersion = '5.0.2'

Definition at line 50 of file MysqlInstaller.php.

MysqlInstaller::$supportedEngines = array( 'InnoDB', 'MyISAM' )

Definition at line 48 of file MysqlInstaller.php.

MysqlInstaller::$webUserPrivs
Initial value:
 array(
        'DELETE',
        'INSERT',
        'SELECT',
        'UPDATE',
        'CREATE TEMPORARY TABLES',
    )

Definition at line 52 of file MysqlInstaller.php.


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