LocalSettingsGenerator Class Reference

Class for generating LocalSettings.php file. More...

Collaboration diagram for LocalSettingsGenerator:

Public Member Functions
	__construct (Installer $installer)
	Constructor. More...
	getText ()
	Return the full text of the generated LocalSettings.php file, including the extensions. More...
	setGroupRights ( $group, $rightsArr)
	For $wgGroupPermissions, set a given ['group']['permission'] value. More...
	writeFile ( $fileName)
	Write the generated LocalSettings to a file. More...

Static Public Member Functions
static	escapePhpString ( $string)
	Returns the escaped version of a string of php code. More...

Protected Member Functions
	buildMemcachedServerList ()
	getDefaultText ()

Protected Attributes
	$dbSettings = ''
	$extensions = array()
	$groupPermissions = array()
Installer	$installer
	$safeMode = false
	$values = array()

Detailed Description

Class for generating LocalSettings.php file.

Since

1.17

Definition at line 30 of file LocalSettingsGenerator.php.

Constructor & Destructor Documentation

__construct()

LocalSettingsGenerator::__construct

(

Installer

$installer

)

Constructor.

Parameters

$installer

Installer subclass

Definition at line 47 of file LocalSettingsGenerator.php.

References $installer, array(), as, escapePhpString(), Installer\getDBInstaller(), Installer\getVar(), values, and wfBoolToStr().

Member Function Documentation

buildMemcachedServerList()

LocalSettingsGenerator::buildMemcachedServerList ( )

protected

Returns

String

Definition at line 168 of file LocalSettingsGenerator.php.

References $ret, as, and values.

Referenced by getDefaultText().

escapePhpString()

static LocalSettingsGenerator::escapePhpString (   $string )

static

Returns the escaped version of a string of php code.

Parameters

$string

String

Returns

String

Definition at line 111 of file LocalSettingsGenerator.php.

References array().

Referenced by __construct(), getDefaultText(), SqliteInstaller\getLocalSettings(), MysqlInstaller\getLocalSettings(), MssqlInstaller\getLocalSettings(), and getText().

getDefaultText()

LocalSettingsGenerator::getDefaultText ( )

protected

Returns

String

Definition at line 189 of file LocalSettingsGenerator.php.

References $right, as, buildMemcachedServerList(), escapePhpString(), values, and wfBoolToStr().

Referenced by getText().

getText()

LocalSettingsGenerator::getText

(

)

Return the full text of the generated LocalSettings.php file, including the extensions.

Returns

String

Definition at line 135 of file LocalSettingsGenerator.php.

References as, escapePhpString(), and getDefaultText().

Referenced by writeFile().

setGroupRights()

LocalSettingsGenerator::setGroupRights	(		$group,
			$rightsArr
	)

For $wgGroupPermissions, set a given ['group']['permission'] value.

Parameters

string	$group	Group name
array	$rightsArr	An array of permissions, in the form of: array( 'right' => true, 'right2' => false )

Definition at line 100 of file LocalSettingsGenerator.php.

writeFile()

LocalSettingsGenerator::writeFile

(

$fileName

)

Write the generated LocalSettings to a file.

Parameters

string

$fileName

Full path to filename to write to

Definition at line 161 of file LocalSettingsGenerator.php.

References getText().

Member Data Documentation

$dbSettings

LocalSettingsGenerator::$dbSettings = ''

protected

Definition at line 35 of file LocalSettingsGenerator.php.

$extensions

LocalSettingsGenerator::$extensions = array()

protected

Definition at line 32 of file LocalSettingsGenerator.php.

$groupPermissions

LocalSettingsGenerator::$groupPermissions = array()

protected

Definition at line 34 of file LocalSettingsGenerator.php.

$installer

Installer LocalSettingsGenerator::$installer

protected

Definition at line 40 of file LocalSettingsGenerator.php.

Referenced by __construct().

$safeMode

LocalSettingsGenerator::$safeMode = false

protected

Definition at line 36 of file LocalSettingsGenerator.php.

$values

LocalSettingsGenerator::$values = array()

protected

Definition at line 33 of file LocalSettingsGenerator.php.

---

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

• includes/installer/LocalSettingsGenerator.php