MediaWiki master
|
Class for setting up the MediaWiki database using MySQL. More...
Inherits DatabaseInstaller.
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 () | |
![]() | |
__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 | |
![]() | |
Database | $db = null |
The database connection. | |
WebInstaller | $parent |
The Installer object. | |
Static Public Attributes | |
static | $minimumVersion |
![]() | |
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. | |
![]() | |
selectDatabase (Database $conn, string $database) | |
Protected Attributes | |
$globalNames | |
$internalDefaults | |
![]() | |
array | $globalNames = [] |
Array of MW configuration globals this class uses. | |
array | $internalDefaults = [] |
Internal variables for installation. | |
Static Protected Attributes | |
static | $notMinimumVersionMessage |
![]() | |
static string | $notMinimumVersionMessage |
Set by subclasses. | |
Additional Inherited Members | |
![]() | |
static | checkExtension ( $name) |
Convenience function. | |
Class for setting up the MediaWiki database using MySQL.
Definition at line 40 of file MysqlInstaller.php.
MysqlInstaller::canCreateAccounts | ( | ) |
Return true if the install user can create accounts.
Definition at line 287 of file MysqlInstaller.php.
References DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), and likeToRegex().
Referenced by getSettingsForm(), and submitSettingsForm().
|
protected |
string | $s | |
string | $escapeChar |
Definition at line 242 of file MysqlInstaller.php.
Referenced by preUpgrade().
MysqlInstaller::getCharsets | ( | ) |
Get a list of character sets that are available and supported.
Definition at line 278 of file MysqlInstaller.php.
Referenced by getSettingsForm(), and submitSettingsForm().
MysqlInstaller::getConnectForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 92 of file MysqlInstaller.php.
References DatabaseInstaller\getCheckBox(), DatabaseInstaller\getInstallUserBox(), DatabaseInstaller\getTextBox(), and wfMessage().
MysqlInstaller::getEngines | ( | ) |
Get a list of storage engines that are available and supported.
Definition at line 253 of file MysqlInstaller.php.
References DatabaseInstaller\getConnection().
Referenced by getSettingsForm(), and submitSettingsForm().
MysqlInstaller::getLocalSettings | ( | ) |
Get the DBMS-specific options for LocalSettings.php generation.
Reimplemented from DatabaseInstaller.
Definition at line 656 of file MysqlInstaller.php.
References getTableOptions(), and DatabaseInstaller\getVar().
MysqlInstaller::getName | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 78 of file MysqlInstaller.php.
MysqlInstaller::getSchemaVars | ( | ) |
Get variables to substitute into tables.sql and the SQL patch files.
Reimplemented from DatabaseInstaller.
Definition at line 647 of file MysqlInstaller.php.
References getTableOptions(), and DatabaseInstaller\getVar().
MysqlInstaller::getSettingsForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 374 of file MysqlInstaller.php.
References canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getVar(), DatabaseInstaller\getWebUserBox(), and DatabaseInstaller\setVar().
|
protected |
Return any table options to be applied to all tables that don't override them.
Definition at line 630 of file MysqlInstaller.php.
References DatabaseInstaller\getVar().
Referenced by getLocalSettings(), and getSchemaVars().
MysqlInstaller::isCompiled | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 85 of file MysqlInstaller.php.
References DatabaseInstaller\checkExtension().
|
protected |
Convert a wildcard (as used in LIKE) to a regex Slashes are escaped, slash terminators included.
string | $wildcard |
Definition at line 362 of file MysqlInstaller.php.
Referenced by canCreateAccounts().
|
static |
Whether the provided version meets the necessary requirements for this type.
IDatabase | $conn |
Reimplemented from DatabaseInstaller.
Definition at line 152 of file MysqlInstaller.php.
References Wikimedia\Rdbms\IReadableDatabase\getSoftwareLink().
MysqlInstaller::openConnection | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 163 of file MysqlInstaller.php.
References DatabaseInstaller\$db, and DatabaseInstaller\getVar().
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 :)
Reimplemented from DatabaseInstaller.
Definition at line 448 of file MysqlInstaller.php.
MysqlInstaller::preUpgrade | ( | ) |
Allow DB installers a chance to make checks before upgrade.
Reimplemented from DatabaseInstaller.
Definition at line 183 of file MysqlInstaller.php.
References $wgDBpassword, $wgDBuser, escapeLikeInternal(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), DatabaseInstaller\selectDatabase(), and DatabaseInstaller\setVar().
MysqlInstaller::setupDatabase | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 460 of file MysqlInstaller.php.
References DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), DatabaseInstaller\selectDatabase(), and DatabaseInstaller\setupSchemaVars().
MysqlInstaller::setupUser | ( | ) |
Definition at line 497 of file MysqlInstaller.php.
References DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), DatabaseInstaller\selectDatabase(), and DatabaseInstaller\setupSchemaVars().
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.
Reimplemented from DatabaseInstaller.
Definition at line 110 of file MysqlInstaller.php.
References DatabaseInstaller\getConnection(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitInstallUserBox().
MysqlInstaller::submitSettingsForm | ( | ) |
Reimplemented from DatabaseInstaller.
Definition at line 401 of file MysqlInstaller.php.
References canCreateAccounts(), getCharsets(), getEngines(), DatabaseInstaller\getVar(), DatabaseInstaller\setVar(), DatabaseInstaller\setVarsFromRequest(), and DatabaseInstaller\submitWebUserBox().
|
protected |
Definition at line 42 of file MysqlInstaller.php.
|
protected |
Definition at line 52 of file MysqlInstaller.php.
|
static |
Definition at line 64 of file MysqlInstaller.php.
|
staticprotected |
Definition at line 65 of file MysqlInstaller.php.
MysqlInstaller::$supportedEngines = [ 'InnoDB' ] |
Definition at line 58 of file MysqlInstaller.php.
MysqlInstaller::$webUserPrivs |
Definition at line 67 of file MysqlInstaller.php.