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.

	getGlobalDefaults ()
	Get a name=>value map of MW configuration globals for the default values.

	getLocalSettings ()

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

	isCompiled ()

	needsUpgrade ()

	openConnection ()

	setupDatabase ()

	setupSearchIndex (&$status)

	submitConnectForm ()

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

	createExtensionTables ()
	Create the tables for each extension the user enabled Stable to override.

	createManualTables ()
	Create database tables from scratch.

	doUpgrade ()
	Perform database upgrades.

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

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

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

	getGeneratedSchemaPath ( $db)
	Return a path to the DBMS-specific automatically generated schema file.

	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.

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

	getSchemaPath ( $db)
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql Stable to override.

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

	getUpdateKeysPath ( $db)
	Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql Stable to override.

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

	getWebUserBox ( $noCreateMsg=false)
	Get a standard web-user fieldset.

	insertUpdateKeys ()
	Insert update keys into table to prevent running unneded updates.

	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.

	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.

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

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

WebInstaller	$parent
	The Installer object.

Static Public Attributes
static	$minimumVersion = '3.8.0'

Static Public Attributes inherited from DatabaseInstaller
static string	$minimumVersion
	Set by subclasses.

Protected Member Functions
	makeStubDBFile ( $dir, $db)

Protected Attributes
	$globalNames

Protected Attributes inherited from DatabaseInstaller
array	$globalNames = []
	Array of MW configuration globals this class uses.

array	$internalDefaults = []
	Internal variables for installation.

Static Protected Attributes
static	$notMinimumVersionMessage = 'config-outdated-sqlite'

Static Protected Attributes inherited from DatabaseInstaller
static string	$notMinimumVersionMessage
	Set by subclasses.

Static Private Member Functions
static	checkDataDir ( $dir)
	Check if the data directory is writable or can be created.

static	createDataDir ( $dir)

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

Additional Inherited Members
Static Public Member Functions inherited from DatabaseInstaller
static	meetsMinimumRequirement ( $serverVersion)
	Whether the provided version meets the necessary requirements for this type.

Static Protected Member Functions inherited from DatabaseInstaller
static	checkExtension ( $name)
	Convenience function.

Detailed Description

Class for setting up the MediaWiki database using SQLLite.

Since: 1.17

Definition at line 34 of file SqliteInstaller.php.

Member Function Documentation

◆ checkDataDir()

static SqliteInstaller::checkDataDir ( $dir )

staticprivate

Check if the data directory is writable or can be created.

Parameters

string $dir Path to the data directory

Returns: Status Return fatal Status if $dir un-writable or no permission to create a directory

Definition at line 144 of file SqliteInstaller.php.

Referenced by submitConnectForm().

◆ checkPrerequisites()

SqliteInstaller::checkPrerequisites ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 60 of file SqliteInstaller.php.

References $db, and Wikimedia\Rdbms\DatabaseSqlite\getServerVersion().

◆ createDataDir()

static SqliteInstaller::createDataDir ( $dir )

staticprivate

Parameters

string $dir Path to the data directory

Returns: Status Return good Status if without error

Definition at line 174 of file SqliteInstaller.php.

References wfMkdirParents().

◆ createTables()

SqliteInstaller::createTables ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 343 of file SqliteInstaller.php.

◆ 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 89 of file SqliteInstaller.php.

References DatabaseInstaller\getTextBox().

◆ getGlobalDefaults()

SqliteInstaller::getGlobalDefaults ( )

Get a name=>value map of MW configuration globals for the default values.

Stable to override

Returns: array

Reimplemented from DatabaseInstaller.

Definition at line 72 of file SqliteInstaller.php.

References $IP, and $path.

◆ getLocalSettings()

SqliteInstaller::getLocalSettings ( )

Returns: string

Reimplemented from DatabaseInstaller.

Definition at line 381 of file SqliteInstaller.php.

◆ getName()

SqliteInstaller::getName ( )

Return the internal name, e.g.

'mysql', or 'sqlite'.

Reimplemented from DatabaseInstaller.

Definition at line 49 of file SqliteInstaller.php.

◆ isCompiled()

SqliteInstaller::isCompiled ( )

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

Reimplemented from DatabaseInstaller.

Definition at line 53 of file SqliteInstaller.php.

References DatabaseInstaller\checkExtension().

◆ makeStubDBFile()

SqliteInstaller::makeStubDBFile	(	$dir,
		$db
	)

protected

Parameters

string	$dir
string	$db

Returns: Status

Definition at line 320 of file SqliteInstaller.php.

References $file.

◆ needsUpgrade()

SqliteInstaller::needsUpgrade ( )

Returns: bool

Reimplemented from DatabaseInstaller.

Definition at line 209 of file SqliteInstaller.php.

◆ openConnection()

SqliteInstaller::openConnection ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 191 of file SqliteInstaller.php.

◆ realpath()

static SqliteInstaller::realpath ( $path )

staticprivate

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

Parameters

string $path

Returns: string

Definition at line 110 of file SqliteInstaller.php.

References $path, and realpath().

Referenced by realpath(), and submitConnectForm().

◆ setupDatabase()

SqliteInstaller::setupDatabase ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 224 of file SqliteInstaller.php.

References $res.

◆ setupSearchIndex()

SqliteInstaller::setupSearchIndex ( & $status )

Parameters

Status &$status

Returns: Status

Definition at line 356 of file SqliteInstaller.php.

References $IP.

◆ submitConnectForm()

SqliteInstaller::submitConnectForm ( )

Returns: Status

Reimplemented from DatabaseInstaller.

Definition at line 122 of file SqliteInstaller.php.

References checkDataDir(), DatabaseInstaller\getVar(), realpath(), DatabaseInstaller\setVar(), and DatabaseInstaller\setVarsFromRequest().

Member Data Documentation

◆ $db

DatabaseSqlite SqliteInstaller::$db

Definition at line 42 of file SqliteInstaller.php.

Referenced by checkPrerequisites().

◆ $globalNames

SqliteInstaller::$globalNames

protected

Initial value:

= [
        'wgDBname',
        'wgSQLiteDataDir',
    ]

Definition at line 44 of file SqliteInstaller.php.

◆ $minimumVersion

SqliteInstaller::$minimumVersion = '3.8.0'

static

Definition at line 36 of file SqliteInstaller.php.

◆ $notMinimumVersionMessage

SqliteInstaller::$notMinimumVersionMessage = 'config-outdated-sqlite'

staticprotected

Definition at line 37 of file SqliteInstaller.php.

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

includes/installer/SqliteInstaller.php

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkDataDir()

◆ checkPrerequisites()

◆ createDataDir()

◆ createTables()

◆ getConnectForm()

◆ getGlobalDefaults()

◆ getLocalSettings()

◆ getName()

◆ isCompiled()

◆ makeStubDBFile()

◆ needsUpgrade()

◆ openConnection()

◆ realpath()

◆ setupDatabase()

◆ setupSearchIndex()

◆ submitConnectForm()

Member Data Documentation

◆ $db

◆ $globalNames

◆ $minimumVersion

◆ $notMinimumVersionMessage