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

Inheritance diagram for SqliteInstaller:

Collaboration diagram for SqliteInstaller:

Public Member Functions
	checkPrerequisites ()

	createTables ()

	getConnectForm ()

	getGlobalDefaults ()

	getLocalSettings ()

	getName ()

	isCompiled ()

	needsUpgrade ()

	openConnection ()

	setupDatabase ()

	setupSearchIndex (&$status)

	submitConnectForm ()

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

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

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

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 Member Functions
	makeStubDBFile ($dir, $db)

Protected Attributes
	$globalNames

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

array	$internalDefaults = []
	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

SqliteInstaller::checkPrerequisites ( )

Returns: Status

Definition at line 55 of file SqliteInstaller.php.

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

SqliteInstaller::createTables ( )

Returns: Status

Definition at line 289 of file SqliteInstaller.php.

References $status, and setupSearchIndex().

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

staticprivate

Parameters

string	$dir
bool	$create

Returns: Status

Definition at line 139 of file SqliteInstaller.php.

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

SqliteInstaller::getConnectForm ( )

Definition at line 84 of file SqliteInstaller.php.

References DatabaseInstaller\getTextBox().

SqliteInstaller::getGlobalDefaults ( )

Definition at line 70 of file SqliteInstaller.php.

References $path.

SqliteInstaller::getLocalSettings ( )

Returns: string

Definition at line 317 of file SqliteInstaller.php.

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

SqliteInstaller::getName ( )

Definition at line 43 of file SqliteInstaller.php.

SqliteInstaller::isCompiled ( )

Definition at line 47 of file SqliteInstaller.php.

SqliteInstaller::makeStubDBFile	(	$dir,
		$db
	)

protected

Definition at line 271 of file SqliteInstaller.php.

References $db, $dir, DatabaseSqlite\generateFileName(), Status\newFatal(), and Status\newGood().

Referenced by setupDatabase().

SqliteInstaller::needsUpgrade ( )

Returns: bool

Definition at line 203 of file SqliteInstaller.php.

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

SqliteInstaller::openConnection ( )

Returns: Status

Definition at line 181 of file SqliteInstaller.php.

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

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

References $path.

SqliteInstaller::setupDatabase ( )

Returns: Status

Definition at line 218 of file SqliteInstaller.php.

References $db, $dir, $e, $status, $wgSQLiteDataDir, DatabaseBase\factory(), DatabaseInstaller\getConnection(), DatabaseInstaller\getVar(), global, makeStubDBFile(), Status\newFatal(), Status\newGood(), DatabaseInstaller\setupSchemaVars(), and DatabaseInstaller\setVar().

SqliteInstaller::setupSearchIndex ( & $status )

Parameters

Status $status

Returns: Status

Definition at line 299 of file SqliteInstaller.php.

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

Referenced by createTables().

SqliteInstaller::submitConnectForm ( )

Returns: Status

Definition at line 117 of file SqliteInstaller.php.

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

Member Data Documentation

DatabaseSqlite SqliteInstaller::$db

Definition at line 36 of file SqliteInstaller.php.

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

SqliteInstaller::$globalNames

protected

Initial value:

= [
        'wgDBname',
        'wgSQLiteDataDir',
    ]

Definition at line 38 of file SqliteInstaller.php.

const SqliteInstaller::MINIMUM_VERSION = '3.3.7'

Definition at line 31 of file SqliteInstaller.php.

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

includes/installer/SqliteInstaller.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation