MediaWiki  REL1_24
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
LocalSettingsGenerator Class Reference
Deployment

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

Collaboration diagram for LocalSettingsGenerator:
Collaboration graph
[legend]

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 and skins.
 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

LocalSettingsGenerator::__construct ( Installer $  installer)

Constructor.

Parameters:
Installer$installer

Definition at line 47 of file LocalSettingsGenerator.php.

Member Function Documentation

LocalSettingsGenerator::buildMemcachedServerList ( ) [protected]
Returns:
string

Definition at line 185 of file LocalSettingsGenerator.php.

static LocalSettingsGenerator::escapePhpString ( $  string) [static]

Returns the escaped version of a string of php code.

Parameters:
string$string
Returns:
string

Definition at line 112 of file LocalSettingsGenerator.php.

Referenced by MysqlInstaller\getLocalSettings(), and MssqlInstaller\getLocalSettings().

LocalSettingsGenerator::getDefaultText ( ) [protected]
Returns:
string

Definition at line 206 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::getText ( )

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

Returns:
string

Definition at line 136 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 101 of file LocalSettingsGenerator.php.

LocalSettingsGenerator::writeFile ( $  fileName)

Write the generated LocalSettings to a file.

Parameters:
string$fileNameFull path to filename to write to

Definition at line 178 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: