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

Inheritance diagram for MssqlInstaller:

Collaboration diagram for MssqlInstaller:

[legend]

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

	createTables ()
	Create database tables from scratch. More...

	getConnectForm ()

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

	getName ()

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

	getSettingsForm ()

	isCompiled ()

	openConnection ()

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

	setupUser ()

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

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

	doUpgrade ()
	Perform database upgrades. More...

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

	getCheckBox ( $var, $label, $attribs=array(), $helpData="")
	Get a labelled checkbox to configure a local boolean variable. 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 that overrides. 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...

	getPasswordBox ( $var, $label, $attribs=array(), $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...

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

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

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

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

	outputHandler ( $string)

	populateInterwikiTable ()
	Common function for databases that don't understand the MySQLish syntax of interwiki.sql. 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...

	submitInstallUserBox ()
	Submit a standard install user fieldset. More...

	submitWebUserBox ()
	Submit the form from getWebUserBox(). More...

Public Attributes
	$minimumVersion = '9.00.1399'

	$webUserPrivs

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

WebInstaller	$parent
	The Installer object. More...

Protected Attributes
	$globalNames

	$internalDefaults

Protected Attributes inherited from DatabaseInstaller
array	$globalNames = array()
	Array of MW configuration globals this class uses. More...

array	$internalDefaults = array()
	Internal variables for installation. 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 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 30 of file MssqlInstaller.php.

Member Function Documentation

◆ canCreateAccounts()

MssqlInstaller::canCreateAccounts ( )

Return true if the install user can create accounts.

Returns: bool

Definition at line 247 of file MssqlInstaller.php.

References $res, array(), 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 $schemaName Catalog name to check

Returns: boolean

Definition at line 663 of file MssqlInstaller.php.

References $res, and array().

Referenced by setupDatabase().

◆ createTables()

MssqlInstaller::createTables ( )

Create database tables from scratch.

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 598 of file MssqlInstaller.php.

References DBExpectedError\getText(), and DatabaseInstaller\getVar().

◆ databaseExists()

MssqlInstaller::databaseExists ( $dbName )

private

Try to see if a given database exists.

Parameters

string $dbName Database name to check

Returns: boolean

Definition at line 641 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

◆ getConnectForm()

MssqlInstaller::getConnectForm ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 78 of file MssqlInstaller.php.

References array(), Html\closeElement(), Html\element(), DatabaseInstaller\getPasswordBox(), DatabaseInstaller\getRadioSet(), DatabaseInstaller\getTextBox(), DatabaseInstaller\getVar(), Html\openElement(), text, and wfMessage().

◆ getLocalSettings()

MssqlInstaller::getLocalSettings ( )

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

Returns: String

Reimplemented from DatabaseInstaller.

Definition at line 682 of file MssqlInstaller.php.

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

◆ getName()

MssqlInstaller::getName ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 64 of file MssqlInstaller.php.

◆ getSchemaVars()

MssqlInstaller::getSchemaVars ( )

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

Returns: array

Reimplemented from DatabaseInstaller.

Definition at line 673 of file MssqlInstaller.php.

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

◆ getSettingsForm()

MssqlInstaller::getSettingsForm ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 341 of file MssqlInstaller.php.

References $s, array(), canCreateAccounts(), Html\closeElement(), Html\element(), DatabaseInstaller\getCheckBox(), DatabaseInstaller\getPasswordBox(), DatabaseInstaller\getRadioSet(), DatabaseInstaller\getTextBox(), DatabaseInstaller\getVar(), Html\openElement(), text, and wfMessage().

◆ isCompiled()

MssqlInstaller::isCompiled ( )

Returns: Bool

Reimplemented from DatabaseInstaller.

Definition at line 71 of file MssqlInstaller.php.

References DatabaseInstaller\checkExtension().

◆ loginExists()

MssqlInstaller::loginExists ( $user )

private

Try to see if the login exists.

Parameters

string $user Username to check

Returns: boolean

Definition at line 620 of file MssqlInstaller.php.

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

Referenced by setupUser().

◆ openConnection()

MssqlInstaller::openConnection ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 190 of file MssqlInstaller.php.

References DatabaseInstaller\$db, $e, $password, $user, array(), DatabaseBase\factory(), DatabaseInstaller\getVar(), global, and Status\newGood().

◆ preInstall()

MssqlInstaller::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 452 of file MssqlInstaller.php.

References array().

◆ preUpgrade()

MssqlInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Reimplemented from DatabaseInstaller.

Definition at line 221 of file MssqlInstaller.php.

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

◆ schemaExists()

MssqlInstaller::schemaExists ( $schemaName )

private

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

Parameters

string $schemaName Schema name to check

Returns: boolean

Definition at line 652 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

◆ setupDatabase()

MssqlInstaller::setupDatabase ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 464 of file MssqlInstaller.php.

References catalogExists(), databaseExists(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), schemaExists(), and DatabaseInstaller\setupSchemaVars().

◆ setupUser()

MssqlInstaller::setupUser ( )

Returns: Status

Definition at line 491 of file MssqlInstaller.php.

References $name, $password, array(), as, DatabaseInstaller\getConnection(), DBExpectedError\getText(), DatabaseInstaller\getVar(), loginExists(), Status\newGood(), DatabaseInstaller\setupSchemaVars(), and userExists().

◆ submitConnectForm()

MssqlInstaller::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 136 of file MssqlInstaller.php.

References $version, array(), DatabaseInstaller\getConnection(), Status\newFatal(), Status\newGood(), DatabaseInstaller\setVar(), and DatabaseInstaller\setVarsFromRequest().

◆ submitSettingsForm()

MssqlInstaller::submitSettingsForm ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 392 of file MssqlInstaller.php.

References $e, $password, $user, array(), canCreateAccounts(), DatabaseBase\factory(), DatabaseInstaller\getVar(), Status\newFatal(), Status\newGood(), DatabaseInstaller\setVar(), and DatabaseInstaller\setVarsFromRequest().

◆ userExists()

MssqlInstaller::userExists ( $user )

private

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

Parameters

string $user Username to check

Returns: boolean

Definition at line 631 of file MssqlInstaller.php.

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

Referenced by setupUser().

Member Data Documentation

◆ $globalNames

MssqlInstaller::$globalNames

protected

Initial value:

= array(
        'wgDBserver',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBmwschema',
        'wgDBprefix',
        'wgDBWindowsAuthentication',
    )

Definition at line 32 of file MssqlInstaller.php.

◆ $internalDefaults

MssqlInstaller::$internalDefaults

protected

Initial value:

= array(
        '_InstallUser' => 'sa',
        '_InstallWindowsAuthentication' => 'sqlauth',
        '_WebWindowsAuthentication' => 'sqlauth',
    )

Definition at line 42 of file MssqlInstaller.php.

◆ $minimumVersion

MssqlInstaller::$minimumVersion = '9.00.1399'

Definition at line 48 of file MssqlInstaller.php.

◆ $webUserPrivs

MssqlInstaller::$webUserPrivs

Initial value:

= array(
        'DELETE',
        'INSERT',
        'SELECT',
        'UPDATE',
        'EXECUTE',
    )

Definition at line 53 of file MssqlInstaller.php.

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

includes/installer/MssqlInstaller.php

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canCreateAccounts()

◆ catalogExists()

◆ createTables()

◆ databaseExists()

◆ getConnectForm()

◆ getLocalSettings()

◆ getName()

◆ getSchemaVars()

◆ getSettingsForm()

◆ isCompiled()

◆ loginExists()

◆ openConnection()

◆ preInstall()

◆ preUpgrade()

◆ schemaExists()

◆ setupDatabase()

◆ setupUser()

◆ submitConnectForm()

◆ submitSettingsForm()

◆ userExists()

Member Data Documentation

◆ $globalNames

◆ $internalDefaults

◆ $minimumVersion

◆ $webUserPrivs