Class for setting up the MediaWiki database using Oracle. More...

Inheritance diagram for OracleInstaller:

Collaboration diagram for OracleInstaller:

Public Member Functions
	createTables ()
	Overload: after this action field info table has to be rebuilt.
	getConnectForm ()
	Get HTML for a web form that configures this database.
	getLocalSettings ()
	Get the DBMS-specific options for LocalSettings.php generation.
	getName ()
	Return the internal name, e.g.
	getSchemaVars ()
	Override this to provide DBMS-specific schema variables, to be substituted into tables.sql and other schema files.
	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.
	openSYSDBAConnection ()
	preInstall ()
	Allow DB installers a chance to make last-minute changes before installation occurs.
	setupDatabase ()
	Create the database and return a Status object indicating success or failure.
	setupUser ()
	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.
Static Public Member Functions
static	checkConnectStringFormat ($connect_string)
	Function checks the format of Oracle connect string The actual validity of the string is checked by attempting to connect.
Public Attributes
	$minimumVersion = '9.0.1'
Protected Attributes
	$connError = null
	$globalNames
	Array of MW configuration globals this class uses.
	$internalDefaults
	Internal variables for installation.

Detailed Description

Class for setting up the MediaWiki database using Oracle.

Since:: 1.17

Definition at line 30 of file OracleInstaller.php.

Member Function Documentation

static OracleInstaller::checkConnectStringFormat ( $ connect_string ) [static]

Function checks the format of Oracle connect string The actual validity of the string is checked by attempting to connect.

Regex should be able to validate all connect string formats [//](host|tns_name)[:port][/service_name][:POOLED] http://www.orafaq.com/wiki/EZCONNECT

Since:: 1.22

Parameters:

string $connect_string

Returns:: bool Whether the connection string is valid.

Definition at line 335 of file OracleInstaller.php.

Referenced by OracleInstallerTest\testCheckConnectStringFormat().

OracleInstaller::createTables ( )

Overload: after this action field info table has to be rebuilt.

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 282 of file OracleInstaller.php.

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

OracleInstaller::getConnectForm ( )

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

Definition at line 58 of file OracleInstaller.php.

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

OracleInstaller::getLocalSettings ( )

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

Returns:: String

Reimplemented from DatabaseInstaller.

Definition at line 313 of file OracleInstaller.php.

References DatabaseInstaller\getVar().

OracleInstaller::getName ( )

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented from DatabaseInstaller.

Definition at line 50 of file OracleInstaller.php.

OracleInstaller::getSchemaVars ( )

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

Returns:: array

Reimplemented from DatabaseInstaller.

Definition at line 294 of file OracleInstaller.php.

References $name, $vars, are, array(), as, DatabaseInstaller\getVar(), tables, used, and user.

OracleInstaller::isCompiled ( )

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

Reimplemented from DatabaseInstaller.

Definition at line 54 of file OracleInstaller.php.

References DatabaseInstaller\checkExtension().

OracleInstaller::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 from DatabaseInstaller.

Definition at line 206 of file OracleInstaller.php.

References DatabaseInstaller\getVar().

OracleInstaller::openConnection ( )

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

Definition at line 166 of file OracleInstaller.php.

References DatabaseInstaller\$db, DatabaseInstaller\getVar(), and Status\newGood().

Referenced by setupUser().

OracleInstaller::openSYSDBAConnection ( )

Definition at line 186 of file OracleInstaller.php.

References DatabaseInstaller\$db, DatabaseInstaller\getVar(), and Status\newGood().

Referenced by setupUser(), and submitConnectForm().

OracleInstaller::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 215 of file OracleInstaller.php.

References array().

OracleInstaller::setupDatabase ( )

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

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 224 of file OracleInstaller.php.

References Status\newGood().

OracleInstaller::setupUser ( )

Definition at line 230 of file OracleInstaller.php.

References $error, $IP, DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), global, Status\newGood(), openConnection(), openSYSDBAConnection(), and DatabaseInstaller\setupSchemaVars().

OracleInstaller::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 92 of file OracleInstaller.php.

References array(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), Status\newFatal(), Status\newGood(), openSYSDBAConnection(), DatabaseInstaller\setVarsFromRequest(), submitInstallUserBox(), and DatabaseInstaller\submitWebUserBox().

OracleInstaller::submitInstallUserBox ( )

Submit a standard install user fieldset.

Returns:: Status

Reimplemented from DatabaseInstaller.

Definition at line 85 of file OracleInstaller.php.

References DatabaseInstaller\getVar(), and Status\newGood().

Referenced by submitConnectForm().

Member Data Documentation

OracleInstaller::$connError = null [protected]

Definition at line 48 of file OracleInstaller.php.

OracleInstaller::$globalNames [protected]

Initial value:

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

Array of MW configuration globals this class uses.

Reimplemented from DatabaseInstaller.

Definition at line 32 of file OracleInstaller.php.

OracleInstaller::$internalDefaults [protected]

Initial value:

 array(
        '_OracleDefTS' => 'USERS',
        '_OracleTempTS' => 'TEMP',
        '_InstallUser' => 'SYSTEM',
    )

Internal variables for installation.

Reimplemented from DatabaseInstaller.

Definition at line 40 of file OracleInstaller.php.

OracleInstaller::$minimumVersion = '9.0.1'

Definition at line 46 of file OracleInstaller.php.

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

includes/installer/OracleInstaller.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation