MediaWiki  REL1_22
LocalSettingsGenerator Class Reference

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

Collaboration diagram for LocalSettingsGenerator:

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.

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

Constructor.

Parameters:
$installerInstaller subclass

Definition at line 47 of file LocalSettingsGenerator.php.


Member Function Documentation

Returns:
String

Definition at line 175 of file LocalSettingsGenerator.php.

static LocalSettingsGenerator::escapePhpString ( string) [static]

Returns the escaped version of a string of php code.

Parameters:
$stringString
Returns:
String

Definition at line 111 of file LocalSettingsGenerator.php.

Referenced by MysqlInstaller\getLocalSettings().

Returns:
String

Definition at line 196 of file LocalSettingsGenerator.php.

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

Returns:
String

Definition at line 135 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::setGroupRights ( group,
rightsArr 
)

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

Parameters:
string$groupGroup name
array$rightsArrAn array of permissions, in the form of: array( 'right' => true, 'right2' => false )

Definition at line 100 of file LocalSettingsGenerator.php.

Write the generated LocalSettings to a file.

Parameters:
string$fileNameFull path to filename to write to

Definition at line 168 of file LocalSettingsGenerator.php.


Member Data Documentation

LocalSettingsGenerator::$dbSettings = '' [protected]

Definition at line 35 of file LocalSettingsGenerator.php.

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

Definition at line 32 of file LocalSettingsGenerator.php.

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

Definition at line 34 of file LocalSettingsGenerator.php.

Installer LocalSettingsGenerator::$installer [protected]

Definition at line 40 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::$safeMode = false [protected]

Definition at line 36 of file LocalSettingsGenerator.php.

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

Definition at line 33 of file LocalSettingsGenerator.php.


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