Class for the core installer command line interface. More...

Collaboration diagram for MediaWiki\Installer\CliInstaller:

[legend]

Public Member Functions
	__construct ( $siteName, $admin=null, array $options=[])

	dirIsExecutable ( $dir, $url)
	Checks if scripts located in the given directory can be executed via the given URL.

	endStage ( $step, $status)

	envCheckPath ()
	Environment check to inform user which paths we've assumed.

	execute ()
	Main entry point.

	showError ( $msg,... $params)
	Same as showMessage(), but for displaying errors.

	showHelpBox ( $msg,... $params)
	Dummy.

	showMessage ( $msg,... $params)
	UI interface for displaying a short message The parameters are like parameters to wfMessage().

	showStatusMessage (Status $status)
	Show a message to the installing user by using a Status object.

	startStage ( $step)

	writeConfigurationFile ( $path)
	Write LocalSettings.php to a given path.

Public Member Functions inherited from MediaWiki\Installer\Installer
	__construct ()
	Constructor, always call this from child classes.

	addInstallStep ( $callback, $findStep='BEGINNING')
	Add an installation step following the given step.

	disableLinkPopups ()

	doEnvironmentChecks ()
	Do initial checks of the PHP environment.

	doEnvironmentPreps ()

	findExtensions ( $directory='extensions')
	Find extensions or skins in a subdirectory of $IP.

	generateKeys ()
	Generate $wgSecretKey.

	getAutoExtensionHookContainer ()
	Get the hook container previously populated by includeExtensions().

	getCompiledDBs ()
	Get a list of DBs supported by current PHP setup.

	getDBInstaller ( $type=false)
	Get an instance of DatabaseInstaller for the specified DB type.

	getDefaultSkin (array $skinNames)
	Returns a default value to be used for $wgDefaultSkin: normally the DefaultSkin from config-schema.yaml, but will fall back to another if the default skin is missing and some other one is present instead.

	getFakePassword ( $realPassword)
	Get a fake password for sending back to the user in HTML.

	getParserOptions ()

	getVar ( $name, $default=null)
	Get an MW configuration variable, or internal installer configuration variable.

	getVirtualDomains ()
	Get the virtual domains.

	parse ( $text, $lineStart=false)
	Convert wikitext $text to HTML.

	performInstallation ( $startCB, $endCB)
	Actually perform the installation.

	populateSiteStats (DatabaseInstaller $installer)
	Install step which adds a row to the site_stats table with appropriate initial values.

	resetMediaWikiServices (?Config $installerConfig=null, $serviceOverrides=[], bool $disableStorage=false)
	Reset the global service container and associated global state to accommodate different stages of the installation.

	restoreLinkPopups ()

	restoreServices ()
	Restore services that have been redefined in the early stage of installation.

	setParserLanguage ( $lang)
	ParserOptions are constructed before we determined the language, so fix it.

	setPassword ( $name, $value)
	Set a variable which stores a password, except if the new value is a fake password in which case leave it as it is.

	setVar ( $name, $value)
	Set a MW configuration variable, or internal installer configuration variable.

Protected Member Functions
	envGetDefaultServer ()
	Helper function to be called from envPrepServer()

	getMessageText ( $msg, $params)

Protected Member Functions inherited from MediaWiki\Installer\Installer
	createMainpage (DatabaseInstaller $installer)
	Insert Main Page with default content.

	createSysop ()
	Create the first user account, grant it sysop, bureaucrat and interface-admin rights.

	disableTimeLimit ()
	Disable the time limit for execution.

	doGenerateKeys ( $keys)
	Generate a secret value for variables using a secure generator.

	envCheck64Bit ()
	Checks if we're running on 64 bit or not.

	envCheckCache ()
	Environment check for compiled object cache types.

	envCheckDB ()
	Environment check for DB types.

	envCheckDiff3 ()
	Search for GNU diff3.

	envCheckGit ()
	Search for git.

	envCheckGraphics ()
	Environment check for ImageMagick and GD.

	envCheckLibicu ()
	Check and display the libicu and Unicode versions.

	envCheckMemory ()
	Environment check for available memory.

	envCheckModSecurity ()
	Scare user to death if they have mod_security or mod_security2.

	envCheckPCRE ()
	Check for known PCRE-related compatibility issues.

	envCheckServer ()
	Environment check to inform user which server we've assumed.

	envCheckUploadsDirectory ()
	Environment check for the permissions of the uploads directory.

	envCheckUploadsServerResponse ()

	envPrepPath ()
	Environment prep for setting $IP and $wgScriptPath.

	envPrepServer ()
	Environment prep for the server hostname.

	findExtensionsByType ( $type='extension', $directory='extensions')
	Find extensions or skins, and return an array containing the value for 'Name' for each found extension.

	getAutoExtensionData ()
	Auto-detect extensions with an extension.json file.

	getAutoExtensionLegacyHooks ()
	Auto-detect extensions with an old style .php registration file, load the extensions, and return the merged $wgHooks array.

	getDocUrl ( $page)
	Overridden by WebInstaller to provide lastPage parameters.

	getExtensionInfo ( $type, $parentRelPath, $name)

	getInstallSteps (DatabaseInstaller $installer)
	Get an array of install steps.

	includeExtensionFiles ( $files)
	Include the specified extension PHP files.

	includeExtensions ()
	Installs the auto-detected extensions.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Installer\Installer
static	apacheModulePresent ( $moduleName)
	Checks for presence of an Apache module.

static	getDBInstallerClass ( $type)
	Get the DatabaseInstaller class name for this type.

static	getDBTypes ()
	Get a list of known DB types.

static	getExistingLocalSettings ()
	Determine if LocalSettings.php exists.

static	getInstallerConfig (Config $baseConfig)
	Constructs a Config object that contains configuration settings that should be overwritten for the installation process.

static	maybeGetWebserverPrimaryGroup ()
	On POSIX systems return the primary group of the webserver we're running under.

static	overrideConfig (SettingsBuilder $settings)
	Override the necessary bits of the config to run an installation.

Public Attributes inherited from MediaWiki\Installer\Installer
array	$licenses
	License types.

array	$rightsProfiles
	User rights profiles.

Protected Attributes inherited from MediaWiki\Installer\Installer
HookContainer null	$autoExtensionHookContainer

array	$compiledDBs
	List of detected DBs, access using getCompiledDBs().

array	$dbInstallers = []
	Cached DB installer instances, access using getDBInstaller().

array	$envChecks
	A list of environment check methods called by doEnvironmentChecks().

array	$envPreps
	A list of environment preparation methods called by doEnvironmentPreps().

array	$extraInstallSteps = []
	Extra steps for installation, for things like DatabaseInstallers to modify.

array	$internalDefaults
	Variables that are stored alongside globals, and are used for any configuration of the installation process aside from the MediaWiki configuration.

int	$minMemorySize = 50
	Minimum memory size in MiB.

array	$objectCaches
	Known object cache types and the functions used to test for their existence.

ParserOptions	$parserOptions
	Cached ParserOptions, used by parse().

Title	$parserTitle
	Cached Title, used by parse().

array	$settings

array	$virtualDomains = []

Static Protected Attributes inherited from MediaWiki\Installer\Installer
static array	$dbTypes
	Known database types.