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

	mergeValues (array $values)
	Set an array of values. More...

	getValues ()
	Get all values. More...

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

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

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

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

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

	lock ($name)
	Make a value read-only. More...

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

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

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

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

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

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

	setConfigTable (ConfigTable $table)
	Set the config table service (must be set) More...

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

static	fromFile ($path, &$reason= '')
	Build a config from a file. More...

static	resolvePath ($settings_path= '', $try_env=true)
	Resolve settings path. More...

static	getEntityTypes ()
	Get the core entity types. More...

Detailed Description

Definition at line 121 of file Config.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

array $values Initial config values from Env/settings file

Definition at line 164 of file Config.php.

Member Function Documentation

Elgg\Config::__get ( $name )

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

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

Parameters

string $name Name

Returns: mixed null if does not exist

Definition at line 375 of file Config.php.

Elgg\Config::__isset ( $name )

Handle isset()

Parameters

string $name Name

Returns: bool

Definition at line 464 of file Config.php.

Elgg\Config::__set	(	$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 451 of file Config.php.

Elgg\Config::__unset ( $name )

Handle unset()

Parameters

string $name Name

Returns: void

Definition at line 474 of file Config.php.

static Elgg\Config::factory	(	$settings_path = `''`,
		$try_env = `true`
	)

static

Build a config from default settings locations.

Parameters

string	$settings_path	Path of settings file
bool	$try_env	If path not given, try $_ENV['ELGG_SETTINGS_FILE']

Returns: Config

Exceptions

ConfigurationException

Definition at line 192 of file Config.php.

static Elgg\Config::fromFile	(		$path,
		&	$reason = `''`
	)

static

Build a config from a file.

Parameters

string	$path	Path of settings.php
string	$reason	Returned reason for failure

Returns: bool|Config false on failure

Definition at line 217 of file Config.php.

Elgg\Config::getCookieConfig ( )

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

Returns: array

Definition at line 334 of file Config.php.

static Elgg\Config::getEntityTypes ( )

static

Get the core entity types.

Returns: string[]

Definition at line 562 of file Config.php.

Elgg\Config::getInitialValue ( $name )

Get a value set at construction time.

Parameters

string $name Name

Returns: mixed null = not set

Definition at line 406 of file Config.php.

Elgg\Config::getValues ( )

Get all values.

Returns: array

Definition at line 325 of file Config.php.

Elgg\Config::hasInitialValue ( $name )

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

Parameters

string $name Name

Returns: bool

Definition at line 417 of file Config.php.

Elgg\Config::hasValue ( $name )

Test if we have a set value.

Parameters

string $name Name

Returns: bool

Definition at line 396 of file Config.php.

Elgg\Config::isLocked ( $name )

Is this value locked?

Parameters

string $name Name

Returns: bool

Definition at line 438 of file Config.php.

Elgg\Config::lock ( $name )

Make a value read-only.

Parameters

string $name Name

Returns: void

Definition at line 427 of file Config.php.

Elgg\Config::mergeValues ( array $values )

Set an array of values.

Parameters

array $values Values

Returns: void

Definition at line 314 of file Config.php.

Elgg\Config::remove ( $name )

Removes a configuration setting from the database.

Parameters

string $name Configuration name

Returns: bool

Definition at line 516 of file Config.php.

static Elgg\Config::resolvePath	(	$settings_path = `''`,
		$try_env = `true`
	)

static

Resolve settings path.

Parameters

string	$settings_path	Path of settings file
bool	$try_env	If path not given, try $_ENV['ELGG_SETTINGS_FILE']

Returns: string

Definition at line 296 of file Config.php.

Elgg\Config::save	(	$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 490 of file Config.php.

Elgg\Config::setConfigTable ( ConfigTable $table )

Set the config table service (must be set)

This is a necessary evil until we refactor so that the service provider has no dependencies.

Parameters

ConfigTable $table the config table service

Returns: void

Definition at line 553 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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation