CRM_Core_BAO_ConfigSetting

class CRM_Core_BAO_ConfigSetting

File contains functions used in civicrm configuration.

Methods

static 
create(array $params)

Create civicrm settings. This is the same as add but it clears the cache and reloads the config object

static 
add(array $params)

Add civicrm settings.

static array
retrieve($defaults)

Retrieve the settings values from db.

static 
applyLocale(SettingsBag $settings, string $activatedLocales)

Evaluate locale preferences and activate a chosen locale by updating session+global variables.

static string
doSiteMove(array $defaultValues = [])

No description

static bool
enableComponent(string $componentName)

Takes a componentName and enables it in the config.

static bool
disableComponent(string $componentName)

Disable specified component.

static 
setEnabledComponents(array $enabledComponents)

Set enabled components.

static array
skipVars()

No description

static array
filterSkipVars(array $params)

No description

Details

at line 47
static create(array $params)

Create civicrm settings. This is the same as add but it clears the cache and reloads the config object

Parameters

array $params Associated array of civicrm variables.

at line 61
static add(array $params)

Add civicrm settings.

Parameters

array $params Associated array of civicrm variables.

at line 89
static array retrieve($defaults)

Retrieve the settings values from db.

Parameters

$defaults

Return Value

array

at line 135
static applyLocale(SettingsBag $settings, string $activatedLocales)

Evaluate locale preferences and activate a chosen locale by updating session+global variables.

Parameters

SettingsBag $settings
string $activatedLocales Imploded list of locales which are supported in the DB.

at line 234
static string doSiteMove(array $defaultValues = [])

Parameters

array $defaultValues

Return Value

string

Exceptions

Exception

at line 300
static bool enableComponent(string $componentName)

Takes a componentName and enables it in the config.

Primarily used during unit testing

Parameters

string $componentName Name of the component to be enabled, needs to be valid.

Return Value

bool true if valid component name and enabling succeeds, else false

at line 328
static bool disableComponent(string $componentName)

Disable specified component.

Parameters

string $componentName

Return Value

bool

at line 351
static setEnabledComponents(array $enabledComponents)

Set enabled components.

Parameters

array $enabledComponents

at line 362
static array skipVars()

Return Value

array

at line 396
static array filterSkipVars(array $params)

Parameters

array $params

Return Value

array