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 wfMsg().
	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 15 of file CliInstaller.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters:

$siteName
$admin
$option	Array

Definition at line 41 of file CliInstaller.php.

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

Here is the call graph for this function:

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.

Reimplemented from Installer.

Definition at line 190 of file CliInstaller.php.

References $dir, and showMessage().

Here is the call graph for this function:

CliInstaller::endStage	(	$	step,
		$	status
	)

Definition at line 128 of file CliInstaller.php.

References showMessage(), and showStatusMessage().

Here is the call graph for this function:

CliInstaller::envCheckPath ( )

Environment check for setting $IP and $wgScriptPath.

Returns:: bool

Reimplemented from Installer.

Definition at line 179 of file CliInstaller.php.

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

Here is the call graph for this function:

CliInstaller::envGetDefaultServer ( ) [protected]

Helper function to be called from envCheckServer()

Returns:: String

Reimplemented from Installer.

Definition at line 186 of file CliInstaller.php.

References Installer\getVar().

Here is the call graph for this function:

CliInstaller::execute ( )

Main entry point.

Definition at line 100 of file CliInstaller.php.

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

Here is the call graph for this function:

CliInstaller::getMessageText ( $ params ) [protected]

Parameters:

$params array

Returns:: string

Definition at line 148 of file CliInstaller.php.

References wfMsgExt().

Referenced by showMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

CliInstaller::showError ( $ msg )

Same as showMessage(), but for displaying errors.

Parameters:

$msg

Reimplemented from Installer.

Definition at line 138 of file CliInstaller.php.

References echo.

CliInstaller::showHelpBox ( $ msg )

Dummy.

Definition at line 160 of file CliInstaller.php.

CliInstaller::showMessage ( $ msg )

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

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 133 of file CliInstaller.php.

References echo, and getMessageText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 163 of file CliInstaller.php.

References echo, Status\getErrorsArray(), and Status\getWarningsArray().

Referenced by endStage(), and execute().

Here is the call graph for this function:

Here is the caller graph for this function:

CliInstaller::startStage ( $ step )

Definition at line 124 of file CliInstaller.php.

References showMessage().

Here is the call graph for this function:

CliInstaller::writeConfigurationFile ( $ path )

Write LocalSettings.php to a given path.

Parameters:

$path String Full path to write LocalSettings.php to

Definition at line 119 of file CliInstaller.php.

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 18 of file CliInstaller.php.

CliInstaller::$specifiedScriptPath = false [private]

Definition at line 16 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