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
	$minimumVersion = '9.00.1399'

	$webUserPrivs

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

WebInstaller	$parent
	The Installer object. 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...

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

MssqlInstaller::canCreateAccounts ( )

Return true if the install user can create accounts.

Returns: bool

Definition at line 259 of file MssqlInstaller.php.

References $res, $status, 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 707 of file MssqlInstaller.php.

References $res.

Referenced by setupDatabase().

MssqlInstaller::createTables ( )

Definition at line 633 of file MssqlInstaller.php.

References $status, 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 685 of file MssqlInstaller.php.

References $res.

Referenced by canCreateAccounts(), and setupDatabase().

MssqlInstaller::getConnectForm ( )

Returns: string

Definition at line 80 of file MssqlInstaller.php.

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

MssqlInstaller::getGlobalDefaults ( )

Definition at line 651 of file MssqlInstaller.php.

MssqlInstaller::getLocalSettings ( )

Definition at line 726 of file MssqlInstaller.php.

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

MssqlInstaller::getName ( )

Returns: string

Definition at line 66 of file MssqlInstaller.php.

MssqlInstaller::getSchemaVars ( )

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

Returns: array

Definition at line 717 of file MssqlInstaller.php.

References DatabaseInstaller\getVar().

MssqlInstaller::getSettingsForm ( )

Returns: string

Definition at line 356 of file MssqlInstaller.php.

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

MssqlInstaller::isCompiled ( )

Returns: bool

Definition at line 73 of file MssqlInstaller.php.

MssqlInstaller::loginExists ( $user )

private

Try to see if the login exists.

Parameters

string $user Username to check

Returns: bool

Definition at line 664 of file MssqlInstaller.php.

References $res, and $user.

Referenced by setupUser().

MssqlInstaller::openConnection ( )

Returns: Status

Definition at line 201 of file MssqlInstaller.php.

References DatabaseInstaller\$db, $e, $status, $user, $wgDBWindowsAuthentication, Database\factory(), DatabaseInstaller\getVar(), global, and StatusValue\newGood().

MssqlInstaller::preInstall ( )

Definition at line 477 of file MssqlInstaller.php.

MssqlInstaller::preUpgrade ( )

Definition at line 233 of file MssqlInstaller.php.

References $status, $wgDBpassword, $wgDBuser, 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 696 of file MssqlInstaller.php.

References $res.

Referenced by canCreateAccounts(), and setupDatabase().

MssqlInstaller::setupDatabase ( )

Returns: Status

Definition at line 489 of file MssqlInstaller.php.

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

MssqlInstaller::setupUser ( )

Returns: Status

Definition at line 525 of file MssqlInstaller.php.

References $name, $status, as, DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), loginExists(), StatusValue\newGood(), DatabaseInstaller\setupSchemaVars(), and userExists().

MssqlInstaller::submitConnectForm ( )

Definition at line 138 of file MssqlInstaller.php.

References $status, DatabaseInstaller\getConnection(), StatusValue\newFatal(), StatusValue\newGood(), DatabaseInstaller\setVar(), and DatabaseInstaller\setVarsFromRequest().

MssqlInstaller::submitSettingsForm ( )

Returns: Status

Definition at line 410 of file MssqlInstaller.php.

References $e, $user, canCreateAccounts(), Database\factory(), DatabaseInstaller\getVar(), StatusValue\newFatal(), StatusValue\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 675 of file MssqlInstaller.php.

References $res, and $user.

Referenced by setupUser().

Member Data Documentation

MssqlInstaller::$globalNames

protected

Initial value:

= [
        'wgDBserver',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBmwschema',
        'wgDBprefix',
        'wgDBWindowsAuthentication',
    ]

Definition at line 32 of file MssqlInstaller.php.

MssqlInstaller::$internalDefaults

protected

Initial value:

= [

'_InstallUser' => 'sa'

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:

= [
        '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

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation