Base class for DBMS-specific installation helper classes. More...

Inheritance diagram for DatabaseInstaller:

Collaboration diagram for DatabaseInstaller:

Public Member Functions
	__construct ($parent)
	Construct and initialise parent.
	checkPrerequisites ()
	Checks for installation prerequisites other than those checked by isCompiled()
	createExtensionTables ()
	Create the tables for each extension the user enabled.
	createTables ()
	Create database tables from scratch.
	doUpgrade ()
	Perform database upgrades.
	enableLB ()
	Set up LBFactory so that wfGetDB() etc.
	getCheckBox ($var, $label, $attribs=array(), $helpData="")
	Get a labelled checkbox to configure a local boolean variable.
	getConnectForm ()
	Get HTML for a web form that configures this database.
	getConnection ()
	Connect to the database using the administrative user/password currently defined in the session.
	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals that overrides.
	getGlobalNames ()
	Get an array of MW configuration globals that will be configured by this class.
	getInstallUserBox ()
	Get a standard install-user fieldset.
	getInternalDefaults ()
	Get a name=>value map of internal variables used during installation.
	getLocalSettings ()
	Get the DBMS-specific options for LocalSettings.php generation.
	getName ()
	Return the internal name, e.g.
	getPasswordBox ($var, $label, $attribs=array(), $helpData="")
	Get a labelled password box to configure a local variable.
	getRadioSet ($params)
	Get a set of labelled radio buttons.
	getReadableName ()
	Get the internationalised name for this DBMS.
	getSchemaVars ()
	Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files.
	getSettingsForm ()
	Get HTML for a web form that retrieves settings used for installation.
	getTextBox ($var, $label, $attribs=array(), $helpData="")
	Get a labelled text box to configure a local variable.
	getVar ($var, $default=null)
	Get a variable, taking local defaults into account.
	getWebUserBox ($noCreateMsg=false)
	Get a standard web-user fieldset.
	isCompiled ()
	needsUpgrade ()
	Determine whether an existing installation of MediaWiki is present in the configured administrative connection.
	openConnection ()
	Open a connection to the database using the administrative user/password currently defined in the session, without any caching.
	outputHandler ($string)
	populateInterwikiTable ()
	Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
	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 ()
	Create the database and return a Status object indicating success or failure.
	setupSchemaVars ()
	Set appropriate schema variables in the current database connection.
	setVar ($name, $value)
	Convenience alias for $this->parent->setVar()
	setVarsFromRequest ($varNames)
	Convenience function to set variables based on form data.
	submitConnectForm ()
	Set variables based on the request array, assuming it was submitted via the form returned by getConnectForm().
	submitInstallUserBox ()
	Submit a standard install user fieldset.
	submitSettingsForm ()
	Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().
	submitWebUserBox ()
	Submit the form from getWebUserBox().
Public Attributes
DatabaseBase	$db = null
	The database connection.
WebInstaller	$parent
	The Installer object.
Static Protected Member Functions
static	checkExtension ($name)
	Convenience function.
Protected Attributes
array	$globalNames = array()
	Array of MW configuration globals this class uses.
array	$internalDefaults = array()
	Internal variables for installation.

Detailed Description

Base class for DBMS-specific installation helper classes.

Since:: 1.17

Definition at line 30 of file DatabaseInstaller.php.

Constructor & Destructor Documentation

DatabaseInstaller::__construct ( $ parent )

Construct and initialise parent.

This is typically only called from Installer::getDBInstaller()

Parameters:

$parent

Definition at line 312 of file DatabaseInstaller.php.

Member Function Documentation

static DatabaseInstaller::checkExtension ( $ name ) [static, protected]

Convenience function.

Check if a named extension is present.

Parameters:

$name

Returns:: bool

Definition at line 323 of file DatabaseInstaller.php.

Referenced by SqliteInstaller\isCompiled(), OracleInstaller\isCompiled(), PostgresInstaller\isCompiled(), and MysqlInstaller\isCompiled().

DatabaseInstaller::checkPrerequisites ( )

Checks for installation prerequisites other than those checked by isCompiled()

Since:: 1.19

Returns:: Status

Reimplemented in SqliteInstaller.

Definition at line 73 of file DatabaseInstaller.php.

DatabaseInstaller::createExtensionTables ( )

Create the tables for each extension the user enabled.

Returns:: Status

Definition at line 203 of file DatabaseInstaller.php.

DatabaseInstaller::createTables ( )

Create database tables from scratch.

Returns:: Status

Reimplemented in PostgresInstaller, OracleInstaller, and SqliteInstaller.

Definition at line 166 of file DatabaseInstaller.php.

DatabaseInstaller::doUpgrade ( )

Perform database upgrades.

Returns:: Boolean

Definition at line 265 of file DatabaseInstaller.php.

DatabaseInstaller::enableLB ( )

Set up LBFactory so that wfGetDB() etc.

works. We set up a special LBFactory instance which returns the current installer connection.

Definition at line 251 of file DatabaseInstaller.php.

Referenced by PostgresInstaller\createTables().

DatabaseInstaller::getCheckBox	(	$	var,
		$	label,
		$	attribs = `array()`,
		$	helpData = `""`
	)

Get a labelled checkbox to configure a local boolean variable.

Returns:: string

Definition at line 439 of file DatabaseInstaller.php.

DatabaseInstaller::getConnectForm ( ) [abstract]

Get HTML for a web form that configures this database.

Configuration at this time should be the minimum needed to connect and test whether install or upgrade is required.

If this is called, $this->parent can be assumed to be a WebInstaller.

Reimplemented in MysqlInstaller, SqliteInstaller, OracleInstaller, and PostgresInstaller.

DatabaseInstaller::getConnection ( )

Connect to the database using the administrative user/password currently defined in the session.

Returns a status object. On success, the status object will contain a Database object in its value member.

This will return a cached connection if one is available.

Returns:: Status

Reimplemented in PostgresInstaller.

Definition at line 145 of file DatabaseInstaller.php.

Referenced by MysqlInstaller\canCreateAccounts(), MysqlInstaller\getEngines(), MysqlInstaller\preUpgrade(), MysqlInstaller\setupDatabase(), OracleInstaller\setupUser(), MysqlInstaller\setupUser(), OracleInstaller\submitConnectForm(), and MysqlInstaller\submitConnectForm().

DatabaseInstaller::getGlobalDefaults ( )

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

DefaultSettings.php

Returns:: array

Reimplemented in MysqlInstaller, and SqliteInstaller.

Definition at line 342 of file DatabaseInstaller.php.

DatabaseInstaller::getGlobalNames ( )

Get an array of MW configuration globals that will be configured by this class.

Returns:: array

Definition at line 303 of file DatabaseInstaller.php.

DatabaseInstaller::getInstallUserBox ( )

Get a standard install-user fieldset.

Returns:: String

Definition at line 513 of file DatabaseInstaller.php.

Referenced by OracleInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), and MysqlInstaller\getConnectForm().

DatabaseInstaller::getInternalDefaults ( )

Get a name=>value map of internal variables used during installation.

Returns:: array

Definition at line 350 of file DatabaseInstaller.php.

DatabaseInstaller::getLocalSettings ( ) [abstract]

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

Returns:: String

Reimplemented in MysqlInstaller, PostgresInstaller, OracleInstaller, and SqliteInstaller.

DatabaseInstaller::getName ( ) [abstract]

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented in MysqlInstaller, OracleInstaller, PostgresInstaller, and SqliteInstaller.

DatabaseInstaller::getPasswordBox	(	$	var,
		$	label,
		$	attribs = `array()`,
		$	helpData = `""`
	)

Get a labelled password box to configure a local variable.

Implements password hiding.

Parameters:

$var	string
$label	string
$attribs	array
$helpData	string

Returns:: string

Definition at line 417 of file DatabaseInstaller.php.

DatabaseInstaller::getRadioSet ( $ params )

Get a set of labelled radio buttons.

Parameters:

$params Array: Parameters are: var: The variable to be configured (required) label: The message name for the label (required) itemLabelPrefix: The message name prefix for the item labels (required) values: List of allowed values (required) itemAttribs Array of attribute arrays, outer key is the value name (optional)

Returns:: string

Definition at line 466 of file DatabaseInstaller.php.

Referenced by MysqlInstaller\getSettingsForm().

DatabaseInstaller::getReadableName ( )

Get the internationalised name for this DBMS.

Returns:: String

Definition at line 331 of file DatabaseInstaller.php.

DatabaseInstaller::getSchemaVars ( )

Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files.

Returns:: array

Reimplemented in MysqlInstaller, and OracleInstaller.

Definition at line 227 of file DatabaseInstaller.php.

DatabaseInstaller::getSettingsForm ( )

Get HTML for a web form that retrieves settings used for installation.

$this->parent can be assumed to be a WebInstaller. If the DB type has no settings beyond those already configured with getConnectForm(), this should return false.

Returns:: bool

Reimplemented in MysqlInstaller, and PostgresInstaller.

Definition at line 104 of file DatabaseInstaller.php.

DatabaseInstaller::getTextBox	(	$	var,
		$	label,
		$	attribs = `array()`,
		$	helpData = `""`
	)

Get a labelled text box to configure a local variable.

Parameters:

$var	string
$label	string
$attribs	array
$helpData	string

Returns:: string

Definition at line 390 of file DatabaseInstaller.php.

Referenced by OracleInstaller\getConnectForm(), PostgresInstaller\getConnectForm(), SqliteInstaller\getConnectForm(), and MysqlInstaller\getConnectForm().

DatabaseInstaller::getVar	(	$	var,
		$	default = `null`
	)

Get a variable, taking local defaults into account.

Parameters:

$var	string
$default	null

Returns:: mixed

Definition at line 360 of file DatabaseInstaller.php.

DatabaseInstaller::getWebUserBox ( $ noCreateMsg = false )

Get a standard web-user fieldset.

Parameters:

string $noCreateMsg Message to display instead of the creation checkbox. Set this to false to show a creation checkbox.

Returns:: String

Definition at line 548 of file DatabaseInstaller.php.

Referenced by OracleInstaller\getConnectForm(), PostgresInstaller\getSettingsForm(), and MysqlInstaller\getSettingsForm().

DatabaseInstaller::isCompiled ( ) [abstract]

Returns:: bool Returns true if the client library is compiled in.

Reimplemented in MysqlInstaller, OracleInstaller, PostgresInstaller, and SqliteInstaller.

DatabaseInstaller::needsUpgrade ( )

Determine whether an existing installation of MediaWiki is present in the configured administrative connection.

Returns true if there is such a wiki, false if the database doesn't exist.

Traditionally, this is done by testing for the existence of either the revision table or the cur table.

Returns:: Boolean

Reimplemented in OracleInstaller, and SqliteInstaller.

Definition at line 494 of file DatabaseInstaller.php.

DatabaseInstaller::openConnection ( ) [abstract]

Open a connection to the database using the administrative user/password currently defined in the session, without any caching.

Returns a status object. On success, the status object will contain a Database object in its value member.

Returns:: Status

Reimplemented in SqliteInstaller, OracleInstaller, MysqlInstaller, and PostgresInstaller.

DatabaseInstaller::outputHandler ( $ string )

Definition at line 634 of file DatabaseInstaller.php.

DatabaseInstaller::populateInterwikiTable ( )

Common function for databases that don't understand the MySQLish syntax of interwiki.sql.

Returns:: Status

Definition at line 597 of file DatabaseInstaller.php.

DatabaseInstaller::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 in MysqlInstaller, PostgresInstaller, and OracleInstaller.

Definition at line 290 of file DatabaseInstaller.php.

DatabaseInstaller::preUpgrade ( )

Allow DB installers a chance to make checks before upgrade.

Reimplemented in PostgresInstaller, and MysqlInstaller.

Definition at line 296 of file DatabaseInstaller.php.

DatabaseInstaller::setupDatabase ( ) [abstract]

Create the database and return a Status object indicating success or failure.

Returns:: Status

Reimplemented in MysqlInstaller, PostgresInstaller, OracleInstaller, and SqliteInstaller.

DatabaseInstaller::setupSchemaVars ( )

Set appropriate schema variables in the current database connection.

This should be called after any request data has been imported, but before any write operations to the database.

Definition at line 237 of file DatabaseInstaller.php.

Referenced by OracleInstaller\createTables(), MysqlInstaller\setupDatabase(), OracleInstaller\setupUser(), and MysqlInstaller\setupUser().

DatabaseInstaller::setVar	(	$	name,
		$	value
	)

Convenience alias for $this->parent->setVar()

Parameters:

$name	string
$value	mixed

Definition at line 377 of file DatabaseInstaller.php.

Referenced by MysqlInstaller\getSettingsForm(), MysqlInstaller\preUpgrade(), PostgresInstaller\submitConnectForm(), PostgresInstaller\submitSettingsForm(), and MysqlInstaller\submitSettingsForm().

DatabaseInstaller::setVarsFromRequest ( $ varNames )

Convenience function to set variables based on form data.

Assumes that variables containing "password" in the name are (potentially fake) passwords.

Parameters:

$varNames Array

Returns:: array

Definition at line 480 of file DatabaseInstaller.php.

Referenced by PostgresInstaller\submitConnectForm(), OracleInstaller\submitConnectForm(), MysqlInstaller\submitConnectForm(), and MysqlInstaller\submitSettingsForm().

DatabaseInstaller::submitConnectForm ( ) [abstract]

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 in SqliteInstaller, MysqlInstaller, OracleInstaller, and PostgresInstaller.

DatabaseInstaller::submitInstallUserBox ( )

Submit a standard install user fieldset.

Returns:: Status

Reimplemented in OracleInstaller.

Definition at line 535 of file DatabaseInstaller.php.

Referenced by PostgresInstaller\submitConnectForm(), and MysqlInstaller\submitConnectForm().

DatabaseInstaller::submitSettingsForm ( )

Set variables based on the request array, assuming it was submitted via the form return by getSettingsForm().

Returns:: Status

Reimplemented in MysqlInstaller, and PostgresInstaller.

Definition at line 114 of file DatabaseInstaller.php.

DatabaseInstaller::submitWebUserBox ( )

Submit the form from getWebUserBox().

Returns:: Status

Definition at line 575 of file DatabaseInstaller.php.

Referenced by OracleInstaller\submitConnectForm(), PostgresInstaller\submitSettingsForm(), and MysqlInstaller\submitSettingsForm().

Member Data Documentation

DatabaseBase DatabaseInstaller::$db = null

The database connection.

Reimplemented in SqliteInstaller.

Definition at line 44 of file DatabaseInstaller.php.

Referenced by MysqlInstaller\openConnection(), OracleInstaller\openConnection(), PostgresInstaller\openConnectionToAnyDB(), PostgresInstaller\openConnectionWithParams(), OracleInstaller\openSYSDBAConnection(), MysqlInstaller\setupUser(), and MysqlInstaller\submitSettingsForm().

array DatabaseInstaller::$globalNames = array() [protected]

Array of MW configuration globals this class uses.

Reimplemented in MysqlInstaller, SqliteInstaller, PostgresInstaller, and OracleInstaller.

Definition at line 56 of file DatabaseInstaller.php.

array DatabaseInstaller::$internalDefaults = array() [protected]

Internal variables for installation.

Reimplemented in MysqlInstaller, OracleInstaller, and PostgresInstaller.

Definition at line 50 of file DatabaseInstaller.php.

WebInstaller DatabaseInstaller::$parent

The Installer object.

Todo:: Naming this parent is confusing, 'installer' would be clearer.

Definition at line 38 of file DatabaseInstaller.php.

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

includes/installer/DatabaseInstaller.php

Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation