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

Inheritance diagram for SqliteInstaller:

Collaboration diagram for SqliteInstaller:

[legend]

Public Member Functions
	checkPrerequisites ()

	createTables ()

	getConnectForm ()
	Get HTML for a web form that configures this database. More...

	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals that overrides. More...

	getLocalSettings ()

	getName ()
	Return the internal name, e.g. More...

	isCompiled ()

	needsUpgrade ()

	openConnection ()

	setupDatabase ()

	setupSearchIndex (&$status)

	submitConnectForm ()

Public Member Functions inherited from DatabaseInstaller
	__construct ( $parent)
	Construct and initialise parent. More...

	createExtensionTables ()
	Create the tables for each extension the user enabled. More...

	doUpgrade ()
	Perform database upgrades. More...

	enableLB ()
	Set up LBFactory so that wfGetDB() etc. More...

	getCheckBox ( $var, $label, $attribs=array(), $helpData="")
	Get a labelled checkbox to configure a local boolean variable. More...

	getConnection ()
	Connect to the database using the administrative user/password currently defined in the session. 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...

	getPasswordBox ( $var, $label, $attribs=array(), $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...

	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=array(), $helpData="")
	Get a labelled text box to configure a local variable. More...

	getVar ( $var, $default=null)
	Get a variable, taking local defaults into account. More...

	getWebUserBox ( $noCreateMsg=false)
	Get a standard web-user fieldset. 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...

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

	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
DatabaseSqlite	$db

const	MINIMUM_VERSION = '3.3.7'

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

WebInstaller	$parent
	The Installer object. More...

Protected Attributes
	$globalNames

Protected Attributes inherited from DatabaseInstaller
array	$globalNames = array()
	Array of MW configuration globals this class uses. More...

array	$internalDefaults = array()
	Internal variables for installation. More...

Static Private Member Functions
static	dataDirOKmaybeCreate ( $dir, $create=false)

static	realpath ( $path)
	Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path. 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 SQLLite.

Since: 1.17

Definition at line 30 of file SqliteInstaller.php.

Member Function Documentation

◆ checkPrerequisites()

SqliteInstaller::checkPrerequisites ( )

Returns: Status:

Reimplemented from DatabaseInstaller.

Definition at line 54 of file SqliteInstaller.php.

References $db, DatabaseSqlite\getFulltextSearchModule(), DatabaseSqlite\getServerVersion(), MINIMUM_VERSION, and Status\newGood().

◆ createTables()

SqliteInstaller::createTables ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 250 of file SqliteInstaller.php.

References setupSearchIndex().

◆ dataDirOKmaybeCreate()

static SqliteInstaller::dataDirOKmaybeCreate	(	$dir,
		$create = `false`
	)

staticprivate

Parameters

$dir
$create	bool

Returns: Status

Definition at line 138 of file SqliteInstaller.php.

References $dir, $ok, Installer\maybeGetWebserverPrimaryGroup(), Status\newFatal(), Status\newGood(), wfMkdirParents(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by setupDatabase(), and submitConnectForm().

◆ getConnectForm()

SqliteInstaller::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 83 of file SqliteInstaller.php.

References array(), and DatabaseInstaller\getTextBox().

◆ getGlobalDefaults()

SqliteInstaller::getGlobalDefaults ( )

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

DefaultSettings.php

Returns: array

Reimplemented from DatabaseInstaller.

Definition at line 69 of file SqliteInstaller.php.

References $path, and array().

◆ getLocalSettings()

SqliteInstaller::getLocalSettings ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 278 of file SqliteInstaller.php.

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

◆ getName()

SqliteInstaller::getName ( )

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented from DatabaseInstaller.

Definition at line 42 of file SqliteInstaller.php.

◆ isCompiled()

SqliteInstaller::isCompiled ( )

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

Reimplemented from DatabaseInstaller.

Definition at line 46 of file SqliteInstaller.php.

References DatabaseInstaller\checkExtension().

◆ needsUpgrade()

SqliteInstaller::needsUpgrade ( )

Returns: bool

Reimplemented from DatabaseInstaller.

Definition at line 202 of file SqliteInstaller.php.

References $dir, DatabaseSqlite\generateFileName(), and DatabaseInstaller\getVar().

◆ openConnection()

SqliteInstaller::openConnection ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 180 of file SqliteInstaller.php.

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

◆ realpath()

static SqliteInstaller::realpath ( $path )

staticprivate

Safe wrapper for PHP's realpath() that fails gracefully if it's unable to canonicalize the path.

Parameters

$path string

Returns: string

Definition at line 104 of file SqliteInstaller.php.

References $path.

Referenced by submitConnectForm().

◆ setupDatabase()

SqliteInstaller::setupDatabase ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 217 of file SqliteInstaller.php.

References $db, $dir, $file, dataDirOKmaybeCreate(), DatabaseSqlite\generateFileName(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), Status\newFatal(), DatabaseInstaller\setupSchemaVars(), and DatabaseInstaller\setVar().

◆ setupSearchIndex()

SqliteInstaller::setupSearchIndex ( & $status )

Parameters

$status Status

Returns: Status

Definition at line 260 of file SqliteInstaller.php.

References $IP, DatabaseSqlite\getFulltextSearchModule(), and global.

Referenced by createTables().

◆ submitConnectForm()

SqliteInstaller::submitConnectForm ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 116 of file SqliteInstaller.php.

References $dir, array(), dataDirOKmaybeCreate(), DatabaseInstaller\getVar(), realpath(), DatabaseInstaller\setVar(), and DatabaseInstaller\setVarsFromRequest().

Member Data Documentation

◆ $db

DatabaseSqlite SqliteInstaller::$db

Definition at line 35 of file SqliteInstaller.php.

Referenced by checkPrerequisites(), openConnection(), and setupDatabase().

◆ $globalNames

SqliteInstaller::$globalNames

protected

Initial value:

= array(
        'wgDBname',
        'wgSQLiteDataDir',
    )

Definition at line 37 of file SqliteInstaller.php.

◆ MINIMUM_VERSION

const SqliteInstaller::MINIMUM_VERSION = '3.3.7'

Definition at line 31 of file SqliteInstaller.php.

Referenced by checkPrerequisites().

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

includes/installer/SqliteInstaller.php

Public Member Functions

Public Attributes

Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkPrerequisites()

◆ createTables()

◆ dataDirOKmaybeCreate()

◆ getConnectForm()

◆ getGlobalDefaults()

◆ getLocalSettings()

◆ getName()

◆ isCompiled()

◆ needsUpgrade()

◆ openConnection()

◆ realpath()

◆ setupDatabase()

◆ setupSearchIndex()

◆ submitConnectForm()

Member Data Documentation

◆ $db

◆ $globalNames

◆ MINIMUM_VERSION