Public Member Functions
	__construct (array $values=[])
	Constructor. More...

	getValues ()
	Get all values. More...

	getCookieConfig ()
	Set up and return the cookie configuration array resolved from settings. More...

	__get (string $name)
	Get an Elgg configuration value if it's been set or loaded during the boot process. More...

	hasValue (string $name)
	Test if we have a set value. More...

	getInitialValue (string $name)
	Get a value set at construction time. More...

	hasInitialValue (string $name)
	Was a value available at construction time? (From settings.php) More...

	isLocked (string $name)
	Is this value locked? More...

	__set (string $name, $value)
	Set an Elgg configuration value. More...

	__isset (string $name)
	Handle isset() More...

	__unset (string $name)
	Handle unset() More...

	save (string $name, $value)
	Save a configuration setting to the database. More...

	remove (string $name)
	Removes a configuration setting from the database. More...

Static Public Member Functions
static	factory (string $settings_path='')
	Build a config from default settings locations. More...

static	resolvePath (string $settings_path='')
	Resolve settings path. More...

Public Attributes
const	ENTITY_TYPES = ['group', 'object', 'site', 'user']

const	SENSITIVE_PROPERTIES

Protected Member Functions
	saveInitialValues (array $values)
	Stores the inital values. More...

	wasWarnedLocked (string $name)
	Log a read-only warning if the name is read-only. More...

Static Protected Member Functions
static	fromFile ($path)
	Build a config from a file. More...

Protected Attributes
array	$locked_values
	The following values can only be set once. More...

array	$deprecated = []
	An array of deprecated config options in the format 'option' => '<version number when deprecated>'. More...

array	$config_defaults
	Holds the set of default values. More...

array	$path_properties
	The path properties will be sanitized when set. More...

Detailed Description

Definition at line 141 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Config::__construct ( array $values = [] )

Constructor.

Parameters

array $values Initial config values from Env/settings file

Definition at line 270 of file Config.php.

Member Function Documentation

◆ __get()

Elgg\Config::__get ( string $name )

Get an Elgg configuration value if it's been set or loaded during the boot process.

Before \Elgg\BootService::boot, values from the database will not be present.

Parameters

string $name Name

Returns: mixed null if does not exist

Definition at line 439 of file Config.php.

◆ __isset()

Elgg\Config::__isset ( string $name )

Handle isset()

Parameters

string $name Name

Returns: bool

Definition at line 528 of file Config.php.

◆ __set()

Elgg\Config::__set	(	string	$name,
			$value
	)

Set an Elgg configuration value.

Warning: This does not persist the configuration setting. Use elgg_save_config()

Parameters

string	$name	Name
mixed	$value	Value

Returns: void

Definition at line 510 of file Config.php.

◆ __unset()

Elgg\Config::__unset ( string $name )

Handle unset()

Parameters

string $name Name

Returns: void

Definition at line 538 of file Config.php.

◆ factory()

static Elgg\Config::factory ( string $settings_path = '' )

static

Build a config from default settings locations.

Parameters

string $settings_path Path of settings file

Returns: Config

Definition at line 302 of file Config.php.

◆ fromFile()

static Elgg\Config::fromFile ( $path )

staticprotected

Build a config from a file.

Parameters

string $path Path of settings.php

Returns: Config

Exceptions

ConfigurationException

Definition at line 316 of file Config.php.

◆ getCookieConfig()

Elgg\Config::getCookieConfig ( )

Set up and return the cookie configuration array resolved from settings.

Returns: array

Definition at line 396 of file Config.php.

◆ getInitialValue()

Elgg\Config::getInitialValue ( string $name )

Get a value set at construction time.

Parameters

string $name Name

Returns: mixed null = not set

Definition at line 474 of file Config.php.

◆ getValues()

Elgg\Config::getValues ( )

Get all values.

Returns: array

Definition at line 387 of file Config.php.

◆ hasInitialValue()

Elgg\Config::hasInitialValue ( string $name )

Was a value available at construction time? (From settings.php)

Parameters

string $name Name

Returns: bool

Definition at line 485 of file Config.php.

◆ hasValue()

Elgg\Config::hasValue ( string $name )

Test if we have a set value.

Parameters

string $name Name

Returns: bool

Definition at line 464 of file Config.php.

◆ isLocked()

Elgg\Config::isLocked ( string $name )

Is this value locked?

Parameters

string $name Name

Returns: bool

Definition at line 496 of file Config.php.

◆ remove()

Elgg\Config::remove ( string $name )

Removes a configuration setting from the database.

Parameters

string $name Configuration name

Returns: bool

Definition at line 583 of file Config.php.

◆ resolvePath()

static Elgg\Config::resolvePath ( string $settings_path = '' )

static

Resolve settings path.

Parameters

string $settings_path Path of settings file

Returns: string

Definition at line 374 of file Config.php.

◆ save()

Elgg\Config::save	(	string	$name,
			$value
	)

Save a configuration setting to the database.

Parameters

string	$name	Name (cannot be greater than 255 characters)
mixed	$value	Value

Returns: bool

Definition at line 554 of file Config.php.

◆ saveInitialValues()

Elgg\Config::saveInitialValues ( array $values )

protected

Stores the inital values.

Parameters

array $values The initial values

Returns: void

Definition at line 286 of file Config.php.

◆ wasWarnedLocked()

Elgg\Config::wasWarnedLocked ( string $name )

protected

Log a read-only warning if the name is read-only.

Parameters

string $name Name

Returns: bool

Definition at line 601 of file Config.php.

Member Data Documentation

◆ $config_defaults

array Elgg\Config::$config_defaults

protected

Holds the set of default values.

Definition at line 173 of file Config.php.

◆ $deprecated

array Elgg\Config::$deprecated = []

protected

An array of deprecated config options in the format 'option' => '<version number when deprecated>'.

Definition at line 168 of file Config.php.

◆ $locked_values

array Elgg\Config::$locked_values

protected

Initial value:

= [
        'assetroot',
        'cacheroot',
        'dataroot',
        'installed',
        'plugins_path',
        'wwwroot',
    ]

The following values can only be set once.

Definition at line 156 of file Config.php.

◆ $path_properties

array Elgg\Config::$path_properties

protected

Initial value:

= [
        'assetroot',
        'cacheroot',
        'dataroot',
        'plugins_path',
    ]

The path properties will be sanitized when set.

Definition at line 236 of file Config.php.

◆ ENTITY_TYPES

const Elgg\Config::ENTITY_TYPES = ['group', 'object', 'site', 'user']

Definition at line 248 of file Config.php.

◆ SENSITIVE_PROPERTIES

const Elgg\Config::SENSITIVE_PROPERTIES

Initial value:

= [
        '__site_secret__',
        'db',
        'dbhost',
        'dbport',
        'dbuser',
        'dbpass',
        'dbname',
    ]

Definition at line 255 of file Config.php.

The documentation for this class was generated from the following file:

engine/classes/Elgg/Config.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ __isset()

◆ __set()

◆ __unset()

◆ factory()

◆ fromFile()

◆ getCookieConfig()

◆ getInitialValue()

◆ getValues()

◆ hasInitialValue()

◆ hasValue()

◆ isLocked()

◆ remove()

◆ resolvePath()

◆ save()

◆ saveInitialValues()

◆ wasWarnedLocked()

Member Data Documentation

◆ $config_defaults

◆ $deprecated

◆ $locked_values

◆ $path_properties

◆ ENTITY_TYPES

◆ SENSITIVE_PROPERTIES