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.
	createTables ()
	Create database tables from scratch.
	getConnectForm ()
	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals that overrides.
	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 = '9.00.1399'
	$webUserPrivs
Protected Attributes
	$globalNames
	Array of MW configuration globals this class uses.
	$internalDefaults
	Internal variables for installation.
Private Member Functions
	catalogExists ($catalogName)
	Try to see if a given fulltext catalog exists We assume we already have the appropriate database selected.
	databaseExists ($dbName)
	Try to see if a given database exists.
	loginExists ($user)
	Try to see if the login exists.
	schemaExists ($schemaName)
	Try to see if a given schema exists We assume we already have the appropriate database selected.
	userExists ($user)
	Try to see if the user account exists We assume we already have the appropriate database selected.

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

MssqlInstaller::canCreateAccounts ( )

Return true if the install user can create accounts.

Returns:: bool

Definition at line 259 of file MssqlInstaller.php.

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

Referenced by getSettingsForm(), and submitSettingsForm().

MssqlInstaller::catalogExists ( $ catalogName ) [private]

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

Parameters:

string $catalogName Catalog name to check

Returns:: bool

Definition at line 708 of file MssqlInstaller.php.

References $res, and array().

Referenced by setupDatabase().

MssqlInstaller::createTables ( )

Create database tables from scratch.

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 634 of file MssqlInstaller.php.

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

MssqlInstaller::databaseExists ( $ dbName ) [private]

Try to see if a given database exists.

Parameters:

string $dbName Database name to check

Returns:: bool

Definition at line 686 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

MssqlInstaller::getConnectForm ( )

Returns:: string

Reimplemented from DatabaseInstaller.

Definition at line 80 of file MssqlInstaller.php.

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

MssqlInstaller::getGlobalDefaults ( )

Get a name=>value map of MW configuration globals that overrides.

DefaultSettings.php

Returns:: array

Reimplemented from DatabaseInstaller.

Definition at line 652 of file MssqlInstaller.php.

References array().

MssqlInstaller::getLocalSettings ( )

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

Returns:: string

Reimplemented from DatabaseInstaller.

Definition at line 727 of file MssqlInstaller.php.

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

MssqlInstaller::getName ( )

Returns:: string

Reimplemented from DatabaseInstaller.

Definition at line 66 of file MssqlInstaller.php.

MssqlInstaller::getSchemaVars ( )

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

Returns:: array

Reimplemented from DatabaseInstaller.

Definition at line 718 of file MssqlInstaller.php.

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

MssqlInstaller::getSettingsForm ( )

Returns:: string

Reimplemented from DatabaseInstaller.

Definition at line 356 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().

MssqlInstaller::isCompiled ( )

Returns:: bool

Reimplemented from DatabaseInstaller.

Definition at line 73 of file MssqlInstaller.php.

References DatabaseInstaller\checkExtension().

MssqlInstaller::loginExists ( $ user ) [private]

Try to see if the login exists.

Parameters:

string $user Username to check

Returns:: bool

Definition at line 665 of file MssqlInstaller.php.

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

Referenced by setupUser().

MssqlInstaller::openConnection ( )

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 201 of file MssqlInstaller.php.

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

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

References array().

MssqlInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Reimplemented from DatabaseInstaller.

Definition at line 233 of file MssqlInstaller.php.

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

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

Definition at line 697 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

MssqlInstaller::setupDatabase ( )

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 489 of file MssqlInstaller.php.

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

MssqlInstaller::setupUser ( )

Returns:: Status

Definition at line 525 of file MssqlInstaller.php.

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

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

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

MssqlInstaller::submitSettingsForm ( )

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 410 of file MssqlInstaller.php.

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

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

Definition at line 676 of file MssqlInstaller.php.

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

Referenced by setupUser().

Member Data Documentation

MssqlInstaller::$globalNames [protected]

Initial value:

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

Array of MW configuration globals this class uses.

Reimplemented from DatabaseInstaller.

Definition at line 32 of file MssqlInstaller.php.

MssqlInstaller::$internalDefaults [protected]

Initial value:

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

Internal variables for installation.

Reimplemented from DatabaseInstaller.

Definition at line 42 of file MssqlInstaller.php.

MssqlInstaller::$minimumVersion = '9.00.1399'

Definition at line 50 of file MssqlInstaller.php.

MssqlInstaller::$webUserPrivs

Initial value:

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

Definition at line 55 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

Detailed Description

Member Function Documentation

Member Data Documentation