1. class
  2. Civi
  3. \
  4. Core
  5. \
  6. SettingsManager

SettingsManager

class SettingsManager

Class SettingsManager

Properties

protected CRM_Utils_Cache_Interface $cache
protected array $bagsByDomain
protected array $bagsByContact
protected array|null $mandatory
protected bool $useDefaults Whether to use defaults.

Methods

__construct(CRM_Utils_Cache_Interface $cache)

No description

SettingsManager
useDefaults()

Ensure that all defaults values are included with all current and future bags.

SettingsManager
useMandatory()

Ensure that mandatory values are included with all current and future bags.

SettingsBag
getBagByDomain(int|null $domainId)

Get Settings by domain.

SettingsBag
getBagByContact(int|null $domainId, int|null $contactId)

Get Settings by contact.

array
getDefaults(string $entity)

Determine the default settings.

array
getMandatory(string $entity)

Get a list of mandatory/overriden settings.

static array
parseMandatorySettings(array $civicrm_setting)

Parse mandatory settings.

SettingsManager
flush()

Flush all in-memory and persistent caches related to settings.

Details

at line 101
__construct(CRM_Utils_Cache_Interface $cache)

Parameters

CRM_Utils_Cache_Interface $cache A semi-durable location to store metadata.

at line 111
SettingsManager useDefaults()

Ensure that all defaults values are included with all current and future bags.

Return Value

SettingsManager

at line 142
SettingsManager useMandatory()

Ensure that mandatory values are included with all current and future bags.

If you call useMandatory multiple times, it will re-scan the global $civicrm_setting.

Return Value

SettingsManager

at line 165
SettingsBag getBagByDomain(int|null $domainId)

Get Settings by domain.

Parameters

int|null $domainId

Return Value

SettingsBag

at line 195
SettingsBag getBagByContact(int|null $domainId, int|null $contactId)

Get Settings by contact.

Parameters

int|null $domainId For the default domain, leave $domainID as NULL.
int|null $contactId For the default/active user's contact, leave $domainID as NULL.

Return Value

SettingsBag

Exceptions

CRM_Core_Exception If there is no contact, then there's no SettingsBag, and we'll throw an exception.

at line 227
protected array getDefaults(string $entity)

Determine the default settings.

Parameters

string $entity Ex: 'domain' or 'contact'.

Return Value

array Array(string $settingName => mixed $value).

at line 256
protected array getMandatory(string $entity)

Get a list of mandatory/overriden settings.

Parameters

string $entity Ex: 'domain' or 'contact'.

Return Value

array Array(string $settingName => mixed $value).

at line 281
static array parseMandatorySettings(array $civicrm_setting)

Parse mandatory settings.

In previous versions, settings were broken down into verbose+dynamic group names, e.g.

$civicrm_settings['Foo Bar Preferences']['foo'] = 'bar';

We now simplify to two simple groups, 'domain' and 'contact'.

$civicrm_settings['domain']['foo'] = 'bar';

However, the old groups are grand-fathered in as aliases.

Parameters

array $civicrm_setting Ex: $civicrm_setting['Group Name']['field'] = 'value'. Group names are an historical quirk; ignore them.

Return Value

array

at line 322
SettingsManager flush()

Flush all in-memory and persistent caches related to settings.

Return Value

SettingsManager