MediaWiki  1.28.1
OracleInstaller Class Reference

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. More...
 
 getConnectForm ()
 
 getLocalSettings ()
 
 getName ()
 
 getSchemaVars ()
 
 isCompiled ()
 
 needsUpgrade ()
 
 openConnection ()
 
 openSYSDBAConnection ()
 
 preInstall ()
 
 setupDatabase ()
 
 setupUser ()
 
 submitConnectForm ()
 
 submitInstallUserBox ()
 
- 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...
 

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. More...
 

Public Attributes

 $minimumVersion = '9.0.1'
 
- Public Attributes inherited from DatabaseInstaller
Database $db = null
 The database connection. More...
 
WebInstaller $parent
 The Installer object. More...
 

Protected Attributes

 $connError = null
 
 $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...
 

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

Referenced by OracleInstallerTest\testCheckConnectStringFormat().

OracleInstaller::createTables ( )

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

Returns
Status

Definition at line 283 of file OracleInstaller.php.

References $status, DBO_DDLMODE, DatabaseInstaller\getVar(), and DatabaseInstaller\setupSchemaVars().

OracleInstaller::getLocalSettings ( )

Definition at line 314 of file OracleInstaller.php.

References DatabaseInstaller\getVar().

OracleInstaller::getName ( )

Definition at line 50 of file OracleInstaller.php.

OracleInstaller::getSchemaVars ( )

Definition at line 295 of file OracleInstaller.php.

References $name, $vars, as, and DatabaseInstaller\getVar().

OracleInstaller::isCompiled ( )

Definition at line 54 of file OracleInstaller.php.

OracleInstaller::needsUpgrade ( )

Definition at line 206 of file OracleInstaller.php.

References DatabaseInstaller\getVar().

OracleInstaller::openConnection ( )
OracleInstaller::openSYSDBAConnection ( )
OracleInstaller::preInstall ( )

Definition at line 215 of file OracleInstaller.php.

OracleInstaller::setupDatabase ( )

Definition at line 224 of file OracleInstaller.php.

References $status, and StatusValue\newGood().

OracleInstaller::submitInstallUserBox ( )

Definition at line 85 of file OracleInstaller.php.

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

Referenced by submitConnectForm().

Member Data Documentation

OracleInstaller::$connError = null
protected

Definition at line 48 of file OracleInstaller.php.

OracleInstaller::$globalNames
protected
Initial value:
= [
'wgDBserver',
'wgDBname',
'wgDBuser',
'wgDBpassword',
'wgDBprefix',
]

Definition at line 32 of file OracleInstaller.php.

OracleInstaller::$internalDefaults
protected
Initial value:
= [
'_OracleDefTS' => 'USERS'

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: