CRM_Core_Config_Runtime

class CRM_Core_Config_Runtime extends CRM_Core_Config_MagicMerge

Class CRM_Core_Config_Runtime

The runtime describes the environment in which CiviCRM executes -- ie the DSN, CMS type, CMS URL, etc. Generally, runtime properties must be determined externally (before loading CiviCRM).

Properties

$dsn
string $userFramework The name of user framework
$userFrameworkBaseURL
$userFrameworkClass
string $userFrameworkDSN The dsn of the database connection for user framework
string $userFrameworkURLVar The name of user framework url variable name
$userFrameworkVersion
$useFrameworkRelativeBase
$userHookClass
string $cleanURL Are we generating clean url's and using mod_rewrite
string $templateDir The root directory of our template tree.

Methods

__construct()

CRM_Core_Config_MagicMerge constructor.

from CRM_Core_Config_MagicMerge
__wakeup()

Set the map to the property map.

from CRM_Core_Config_MagicMerge
static array
getPropertyMap()

Get a list of $config properties and the entities to which they map.

from CRM_Core_Config_MagicMerge
mixed
__get(string $k)

Get value.

from CRM_Core_Config_MagicMerge
__set(string $k, mixed $v)

Set value.

from CRM_Core_Config_MagicMerge
bool
__isset(string $k)

Is value set.

from CRM_Core_Config_MagicMerge
__unset(string $k)

Unset value.

from CRM_Core_Config_MagicMerge
SettingsBag
getSettings()

No description

from CRM_Core_Config_MagicMerge
initialize(bool $loadFromDB = TRUE)

No description

includeCustomPath()

Include custom PHP and template paths

static mixed
getId()

Create a unique identification code for this runtime.

Details

in CRM_Core_Config_MagicMerge at line 65
__construct()

CRM_Core_Config_MagicMerge constructor.

in CRM_Core_Config_MagicMerge at line 72
__wakeup()

Set the map to the property map.

in CRM_Core_Config_MagicMerge at line 87
static array getPropertyMap()

Get a list of $config properties and the entities to which they map.

This is used for two purposes:

  1. Runtime: Provide backward-compatible interface for reading these properties.
  2. Upgrade: Migrate old properties of config_backend into settings.

Return Value

array

in CRM_Core_Config_MagicMerge at line 234
mixed __get(string $k)

Get value.

Parameters

string $k

Return Value

mixed

Exceptions

CRM_Core_Exception

in CRM_Core_Config_MagicMerge at line 323
__set(string $k, mixed $v)

Set value.

Parameters

string $k
mixed $v

Exceptions

CRM_Core_Exception

in CRM_Core_Config_MagicMerge at line 360
bool __isset(string $k)

Is value set.

Parameters

string $k

Return Value

bool

in CRM_Core_Config_MagicMerge at line 371
__unset(string $k)

Unset value.

Parameters

string $k

Exceptions

CRM_Core_Exception

in CRM_Core_Config_MagicMerge at line 407
protected SettingsBag getSettings()

Return Value

SettingsBag

at line 85
initialize(bool $loadFromDB = TRUE)

Parameters

bool $loadFromDB

at line 133
includeCustomPath()

Include custom PHP and template paths

at line 153
static mixed getId()

Create a unique identification code for this runtime.

If two requests involve a different hostname, different port, different DSN, etc., then they should also have a different runtime ID.

Return Value

mixed