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

Inheritance diagram for CliInstaller:

Collaboration diagram for CliInstaller:

Public Member Functions
	__construct ($siteName, $admin=null, array $option=array())
	Constructor.
	dirIsExecutable ($dir, $url)
	Checks if scripts located in the given directory can be executed via the given URL.
	endStage ($step, $status)
	envCheckPath ()
	Environment check for setting $IP and $wgScriptPath.
	execute ()
	Main entry point.
	showError ($msg)
	Same as showMessage(), but for displaying errors.
	showHelpBox ($msg)
	Dummy.
	showMessage ($msg)
	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.
Protected Member Functions
	envGetDefaultServer ()
	Helper function to be called from envCheckServer()
	getMessageText ($params)
Private Attributes
	$optionMap
	$specifiedScriptPath = false

Detailed Description

Class for the core installer command line interface.

Since:: 1.17

Definition at line 30 of file CliInstaller.php.

Constructor & Destructor Documentation

CliInstaller::__construct	(	$	siteName,
		$	admin = `null`,
		array $	option = `array()`
	)

Constructor.

Parameters:

$siteName
$admin
$option	Array

Definition at line 56 of file CliInstaller.php.

References $wgContLang, $wgLang, Installer\__construct(), as, Language\factory(), Installer\getVar(), global, and Installer\setVar().

Member Function Documentation

CliInstaller::dirIsExecutable	(	$	dir,
		$	url
	)

Checks if scripts located in the given directory can be executed via the given URL.

Used only by environment checks.

Parameters:

$dir	string
$url	string

Returns:: bool|int|string

Reimplemented from Installer.

Definition at line 209 of file CliInstaller.php.

References $dir, and showMessage().

CliInstaller::endStage	(	$	step,
		$	status
	)

Definition at line 145 of file CliInstaller.php.

References showMessage(), and showStatusMessage().

CliInstaller::envCheckPath ( )

Environment check for setting $IP and $wgScriptPath.

Returns:: bool

Reimplemented from Installer.

Definition at line 197 of file CliInstaller.php.

References Installer\getVar(), and showMessage().

CliInstaller::envGetDefaultServer ( ) [protected]

Helper function to be called from envCheckServer()

Returns:: String

Reimplemented from Installer.

Definition at line 205 of file CliInstaller.php.

CliInstaller::execute ( )

Main entry point.

Definition at line 115 of file CliInstaller.php.

References $vars, array(), Installer\getExistingLocalSettings(), Status\newFatal(), Installer\performInstallation(), and showStatusMessage().

CliInstaller::getMessageText ( $ params ) [protected]

Parameters:

$params array

Returns:: string

Definition at line 165 of file CliInstaller.php.

References $params, and wfMessage().

Referenced by showMessage().

CliInstaller::showError ( $ msg )

Same as showMessage(), but for displaying errors.

Parameters:

$msg

Reimplemented from Installer.

Definition at line 155 of file CliInstaller.php.

CliInstaller::showHelpBox ( $ msg )

Dummy.

Definition at line 178 of file CliInstaller.php.

CliInstaller::showMessage ( $ msg )

UI interface for displaying a short message The parameters are like parameters to wfMessage().

The messages will be in wikitext format, which will be converted to an output format such as HTML or text before being sent to the user.

Parameters:

$msg

Reimplemented from Installer.

Definition at line 150 of file CliInstaller.php.

References getMessageText().

Referenced by dirIsExecutable(), endStage(), envCheckPath(), and startStage().

CliInstaller::showStatusMessage ( Status $ status )

Show a message to the installing user by using a Status object.

Parameters:

$status Status

Reimplemented from Installer.

Definition at line 181 of file CliInstaller.php.

References array(), as, Status\getErrorsArray(), and Status\getWarningsArray().

Referenced by endStage(), and execute().

CliInstaller::startStage ( $ step )

Definition at line 139 of file CliInstaller.php.

References showMessage().

CliInstaller::writeConfigurationFile ( $ path )

Write LocalSettings.php to a given path.

Parameters:

string $path Full path to write LocalSettings.php to

Definition at line 134 of file CliInstaller.php.

References InstallerOverrides\getLocalSettingsGenerator().

Member Data Documentation

CliInstaller::$optionMap [private]

Initial value:

 array(
        'dbtype' => 'wgDBtype',
        'dbserver' => 'wgDBserver',
        'dbname' => 'wgDBname',
        'dbuser' => 'wgDBuser',
        'dbpass' => 'wgDBpassword',
        'dbprefix' => 'wgDBprefix',
        'dbtableoptions' => 'wgDBTableOptions',
        'dbmysql5' => 'wgDBmysql5',
        'dbport' => 'wgDBport',
        'dbschema' => 'wgDBmwschema',
        'dbpath' => 'wgSQLiteDataDir',
        'server' => 'wgServer',
        'scriptpath' => 'wgScriptPath',
    )

Definition at line 33 of file CliInstaller.php.

CliInstaller::$specifiedScriptPath = false [private]

Definition at line 31 of file CliInstaller.php.

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

includes/installer/CliInstaller.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation