MediaWiki  master
MssqlInstaller Class Reference

Class for setting up the MediaWiki database using Microsoft SQL Server. More...

Inheritance diagram for MssqlInstaller:
Collaboration diagram for MssqlInstaller:

Public Member Functions

 canCreateAccounts ()
 Return true if the install user can create accounts. More...
 
 createTables ()
 
 getConnectForm ()
 
 getGlobalDefaults ()
 
 getLocalSettings ()
 
 getName ()
 
 getSchemaVars ()
 Get variables to substitute into tables.sql and the SQL patch files. More...
 
 getSettingsForm ()
 
 isCompiled ()
 
 openConnection ()
 
 preInstall ()
 
 preUpgrade ()
 
 setupDatabase ()
 
 setupUser ()
 
 submitConnectForm ()
 
 submitSettingsForm ()
 
- Public Member Functions inherited from DatabaseInstaller
 __construct ( $parent)
 Construct and initialise parent. More...
 
 checkPrerequisites ()
 Checks for installation prerequisites other than those checked by isCompiled() More...
 
 createExtensionTables ()
 Create the tables for each extension the user enabled. More...
 
 createTables ()
 Create database tables from scratch. More...
 
 doUpgrade ()
 Perform database upgrades. More...
 
 enableLB ()
 Set up LBFactory so that wfGetDB() etc. More...
 
 getCheckBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled checkbox to configure a local boolean variable. More...
 
 getConnectForm ()
 Get HTML for a web form that configures this database. More...
 
 getConnection ()
 Connect to the database using the administrative user/password currently defined in the session. More...
 
 getGlobalDefaults ()
 Get a name=>value map of MW configuration globals for the default values. More...
 
 getGlobalNames ()
 Get an array of MW configuration globals that will be configured by this class. More...
 
 getInstallUserBox ()
 Get a standard install-user fieldset. More...
 
 getInternalDefaults ()
 Get a name=>value map of internal variables used during installation. More...
 
 getLocalSettings ()
 Get the DBMS-specific options for LocalSettings.php generation. More...
 
 getName ()
 Return the internal name, e.g. More...
 
 getPasswordBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled password box to configure a local variable. More...
 
 getRadioSet ( $params)
 Get a set of labelled radio buttons. More...
 
 getReadableName ()
 Get the internationalised name for this DBMS. More...
 
 getSchemaPath ( $db)
 Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...
 
 getSchemaVars ()
 Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files. More...
 
 getSettingsForm ()
 Get HTML for a web form that retrieves settings used for installation. More...
 
 getTextBox ( $var, $label, $attribs=[], $helpData="")
 Get a labelled text box to configure a local variable. More...
 
 getUpdateKeysPath ( $db)
 Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql. More...
 
 getVar ( $var, $default=null)
 Get a variable, taking local defaults into account. More...
 
 getWebUserBox ( $noCreateMsg=false)
 Get a standard web-user fieldset. More...
 
 insertUpdateKeys ()
 Insert update keys into table to prevent running unneded updates. More...
 
 isCompiled ()
 
 needsUpgrade ()
 Determine whether an existing installation of MediaWiki is present in the configured administrative connection. More...
 
 openConnection ()
 Open a connection to the database using the administrative user/password currently defined in the session, without any caching. More...
 
 outputHandler ( $string)
 
 populateInterwikiTable ()
 Common function for databases that don't understand the MySQLish syntax of interwiki.sql. More...
 
 preInstall ()
 Allow DB installers a chance to make last-minute changes before installation occurs. More...
 
 preUpgrade ()
 Allow DB installers a chance to make checks before upgrade. More...
 
 setupDatabase ()
 Create the database and return a Status object indicating success or failure. More...
 
 setupSchemaVars ()
 Set appropriate schema variables in the current database connection. More...
 
 setVar ( $name, $value)
 Convenience alias for $this->parent->setVar() More...
 
 setVarsFromRequest ( $varNames)
 Convenience function to set variables based on form data. More...
 
 submitConnectForm ()
 Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm(). More...
 
 submitInstallUserBox ()
 Submit a standard install user fieldset. More...
 
 submitSettingsForm ()
 Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm(). More...
 
 submitWebUserBox ()
 Submit the form from getWebUserBox(). More...
 

Public Attributes

 $webUserPrivs
 
- Public Attributes inherited from DatabaseInstaller
Database $db = null
 The database connection. More...
 
WebInstaller $parent
 The Installer object. More...
 

Static Public Attributes

static $minimumVersion = '9.00.1399'
 
- Static Public Attributes inherited from DatabaseInstaller
static string $minimumVersion
 Set by subclasses. More...
 

Protected Attributes

 $globalNames
 
 $internalDefaults
 
- Protected Attributes inherited from DatabaseInstaller
array $globalNames = []
 Array of MW configuration globals this class uses. More...
 
array $internalDefaults = []
 Internal variables for installation. More...
 

Static Protected Attributes

static $notMinimumVersionMessage = 'config-mssql-old'
 
- Static Protected Attributes inherited from DatabaseInstaller
static string $notMinimumVersionMessage
 Set by subclasses. More...
 

Private Member Functions

 catalogExists ( $catalogName)
 Try to see if a given fulltext catalog exists We assume we already have the appropriate database selected. More...
 
 databaseExists ( $dbName)
 Try to see if a given database exists. More...
 
 loginExists ( $user)
 Try to see if the login exists. More...
 
 schemaExists ( $schemaName)
 Try to see if a given schema exists We assume we already have the appropriate database selected. More...
 
 userExists ( $user)
 Try to see if the user account exists We assume we already have the appropriate database selected. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DatabaseInstaller
static meetsMinimumRequirement ( $serverVersion)
 Whether the provided version meets the necessary requirements for this type. More...
 
- Static Protected Member Functions inherited from DatabaseInstaller
static checkExtension ( $name)
 Convenience function. More...
 

Detailed Description

Class for setting up the MediaWiki database using Microsoft SQL Server.

Since
1.23

Definition at line 34 of file MssqlInstaller.php.

Member Function Documentation

◆ canCreateAccounts()

MssqlInstaller::canCreateAccounts ( )

Return true if the install user can create accounts.

Returns
bool

Definition at line 260 of file MssqlInstaller.php.

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

Referenced by getSettingsForm(), and submitSettingsForm().

◆ catalogExists()

MssqlInstaller::catalogExists (   $catalogName)
private

Try to see if a given fulltext catalog exists We assume we already have the appropriate database selected.

Parameters
string$catalogNameCatalog name to check
Returns
bool

Definition at line 708 of file MssqlInstaller.php.

References $res.

Referenced by setupDatabase().

◆ createTables()

MssqlInstaller::createTables ( )

Definition at line 634 of file MssqlInstaller.php.

References DatabaseInstaller\getVar().

◆ databaseExists()

MssqlInstaller::databaseExists (   $dbName)
private

Try to see if a given database exists.

Parameters
string$dbNameDatabase name to check
Returns
bool

Definition at line 686 of file MssqlInstaller.php.

References $res.

Referenced by canCreateAccounts(), and setupDatabase().

◆ getConnectForm()

◆ getGlobalDefaults()

MssqlInstaller::getGlobalDefaults ( )

Definition at line 652 of file MssqlInstaller.php.

◆ getLocalSettings()

MssqlInstaller::getLocalSettings ( )

◆ getName()

MssqlInstaller::getName ( )
Returns
string

Definition at line 71 of file MssqlInstaller.php.

◆ getSchemaVars()

MssqlInstaller::getSchemaVars ( )

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

Returns
array

Definition at line 718 of file MssqlInstaller.php.

References DatabaseInstaller\getVar().

◆ getSettingsForm()

◆ isCompiled()

MssqlInstaller::isCompiled ( )
Returns
bool

Definition at line 78 of file MssqlInstaller.php.

◆ loginExists()

MssqlInstaller::loginExists (   $user)
private

Try to see if the login exists.

Parameters
string$userUsername to check
Returns
bool

Definition at line 665 of file MssqlInstaller.php.

References $res, and $user.

Referenced by setupUser().

◆ openConnection()

MssqlInstaller::openConnection ( )

◆ preInstall()

MssqlInstaller::preInstall ( )

Definition at line 478 of file MssqlInstaller.php.

◆ preUpgrade()

MssqlInstaller::preUpgrade ( )

◆ schemaExists()

MssqlInstaller::schemaExists (   $schemaName)
private

Try to see if a given schema exists We assume we already have the appropriate database selected.

Parameters
string$schemaNameSchema name to check
Returns
bool

Definition at line 697 of file MssqlInstaller.php.

References $res.

Referenced by canCreateAccounts(), and setupDatabase().

◆ setupDatabase()

◆ setupUser()

◆ submitConnectForm()

◆ submitSettingsForm()

◆ userExists()

MssqlInstaller::userExists (   $user)
private

Try to see if the user account exists We assume we already have the appropriate database selected.

Parameters
string$userUsername to check
Returns
bool

Definition at line 676 of file MssqlInstaller.php.

References $res, and $user.

Referenced by setupUser().

Member Data Documentation

◆ $globalNames

MssqlInstaller::$globalNames
protected
Initial value:
= [
'wgDBserver',
'wgDBname',
'wgDBuser',
'wgDBpassword',
'wgDBmwschema',
'wgDBprefix',
'wgDBWindowsAuthentication',
]

Definition at line 36 of file MssqlInstaller.php.

◆ $internalDefaults

MssqlInstaller::$internalDefaults
protected
Initial value:
= [
'_InstallUser' => 'sa'

Definition at line 46 of file MssqlInstaller.php.

◆ $minimumVersion

MssqlInstaller::$minimumVersion = '9.00.1399'
static

Definition at line 54 of file MssqlInstaller.php.

◆ $notMinimumVersionMessage

MssqlInstaller::$notMinimumVersionMessage = 'config-mssql-old'
staticprotected

Definition at line 55 of file MssqlInstaller.php.

◆ $webUserPrivs

MssqlInstaller::$webUserPrivs
Initial value:
= [
'DELETE',
'INSERT',
'SELECT',
'UPDATE',
'EXECUTE',
]

Definition at line 60 of file MssqlInstaller.php.


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