Documentation

CRM_Core_Config_Runtime
in package

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).

Table of Contents

Properties

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

Methods

getId()  : mixed
Create a unique identification code for this runtime.
includeCustomPath()  : mixed
Include custom PHP and template paths
initialize()  : mixed
fatal()  : mixed
Exit processing after a fatal event, outputting the message.

Properties

$cleanURL

Are we generating clean url's and using mod_rewrite

public string $cleanURL

$initialized

public bool $initialized

$templateDir

The root directory of our template tree.

public string $templateDir

$useFrameworkRelativeBase

public mixed $useFrameworkRelativeBase

$userFramework

The name of user framework

public string $userFramework

$userFrameworkBaseURL

public mixed $userFrameworkBaseURL

$userFrameworkClass

public mixed $userFrameworkClass

$userFrameworkDSN

The dsn of the database connection for user framework

public string $userFrameworkDSN

$userFrameworkURLVar

The name of user framework url variable name

public string $userFrameworkURLVar = 'q'

$userFrameworkVersion

public mixed $userFrameworkVersion

$userHookClass

public mixed $userHookClass

Methods

getId()

Create a unique identification code for this runtime.

public static getId() : mixed

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

includeCustomPath()

Include custom PHP and template paths

public includeCustomPath() : mixed

initialize()

public initialize([bool $loadFromDB = TRUE ]) : mixed
Parameters
$loadFromDB : bool = TRUE

fatal()

Exit processing after a fatal event, outputting the message.

private fatal(string $message) : mixed
Parameters
$message : string

        
On this page

Search results