MediaWiki  REL1_23
MssqlInstaller Class Reference

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

Inheritance diagram for MssqlInstaller:
Collaboration diagram for MssqlInstaller:

List of all members.

Public Member Functions

 canCreateAccounts ()
 Return true if the install user can create accounts.
 createTables ()
 Create database tables from scratch.
 getConnectForm ()
 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

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

MssqlInstaller::catalogExists ( catalogName) [private]

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

Parameters:
string$schemaNameCatalog name to check
Returns:
boolean

Definition at line 663 of file MssqlInstaller.php.

References $res, and array().

Referenced by setupDatabase().

Create database tables from scratch.

Returns:
Status

Reimplemented from DatabaseInstaller.

Definition at line 598 of file MssqlInstaller.php.

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

MssqlInstaller::databaseExists ( dbName) [private]

Try to see if a given database exists.

Parameters:
string$dbNameDatabase name to check
Returns:
boolean

Definition at line 641 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

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

Returns:
string

Reimplemented from DatabaseInstaller.

Definition at line 64 of file MssqlInstaller.php.

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

Returns:
Bool

Reimplemented from DatabaseInstaller.

Definition at line 71 of file MssqlInstaller.php.

References DatabaseInstaller\checkExtension().

MssqlInstaller::loginExists ( user) [private]

Try to see if the login exists.

Parameters:
string$userUsername to check
Returns:
boolean

Definition at line 620 of file MssqlInstaller.php.

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

Referenced by setupUser().

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

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.

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

Definition at line 652 of file MssqlInstaller.php.

References $res, and array().

Referenced by canCreateAccounts(), and setupDatabase().

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 array(), DatabaseInstaller\getConnection(), 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$userUsername to check
Returns:
boolean

Definition at line 631 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 48 of file MssqlInstaller.php.

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: