LocalSettingsGenerator Class Reference

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

List of all members.

Public Member Functions
	__construct (Installer $installer)
	Constructor.
	getText ()
	Return the full text of the generated LocalSettings.php file, including the extensions.
	setGroupRights ($group, $rightsArr)
	For $wgGroupPermissions, set a given ['group']['permission'] value.
	writeFile ($fileName)
	Write the generated LocalSettings to a file.
Static Public Member Functions
static	escapePhpString ($string)
	Returns the escaped version of a string of php code.
Private Member Functions
	buildMemcachedServerList ()
	getDefaultText ()
Private Attributes
	$dbSettings = ''
	$extensions = array()
	$groupPermissions = array()
	$installer
	$safeMode = false
	$values = array()

---

Detailed Description

Class for generating LocalSettings.php file.

Since:

1.17

Definition at line 15 of file LocalSettingsGenerator.php.

---

Constructor & Destructor Documentation

LocalSettingsGenerator::__construct

(

Installer $

installer

)

Constructor.

Parameters:

$installer

Installer subclass

Definition at line 33 of file LocalSettingsGenerator.php.

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

Here is the call graph for this function:

---

Member Function Documentation

LocalSettingsGenerator::buildMemcachedServerList

(

)

[private]

Returns:

String

Definition at line 154 of file LocalSettingsGenerator.php.

Referenced by getDefaultText().

Here is the caller graph for this function:

static LocalSettingsGenerator::escapePhpString

(

$

string

)

[static]

Returns the escaped version of a string of php code.

Parameters:

$string

String

Returns:

String

Definition at line 97 of file LocalSettingsGenerator.php.

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

Here is the caller graph for this function:

LocalSettingsGenerator::getDefaultText

(

)

[private]

Returns:

String

Definition at line 175 of file LocalSettingsGenerator.php.

References buildMemcachedServerList(), escapePhpString(), and wfBoolToStr().

Referenced by getText().

Here is the call graph for this function:

Here is the caller graph for this function:

LocalSettingsGenerator::getText

(

)

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

Returns:

String

Definition at line 121 of file LocalSettingsGenerator.php.

References escapePhpString(), and getDefaultText().

Referenced by writeFile().

Here is the call graph for this function:

Here is the caller graph for this function:

LocalSettingsGenerator::setGroupRights	(	$	group,
		$	rightsArr
	)

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

Parameters:

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

Definition at line 86 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::writeFile

(

$

fileName

)

Write the generated LocalSettings to a file.

Parameters:

$fileName

String Full path to filename to write to

Definition at line 147 of file LocalSettingsGenerator.php.

References getText().

Here is the call graph for this function:

---

Member Data Documentation

LocalSettingsGenerator::$dbSettings = '' [private]

Definition at line 20 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::$extensions = array() [private]

Definition at line 17 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::$groupPermissions = array() [private]

Definition at line 19 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::$installer [private]

Definition at line 26 of file LocalSettingsGenerator.php.

Referenced by __construct().

LocalSettingsGenerator::$safeMode = false [private]

Definition at line 21 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::$values = array() [private]

Definition at line 18 of file LocalSettingsGenerator.php.

---

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

• includes/installer/LocalSettingsGenerator.php