Elgg  Version master
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Elgg\Config Class Reference

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= '', bool $try_env=true)
 Build a config from default settings locations. More...
 
static fromFile ($path, &$reason= '')
 Build a config from a file. More...
 
static resolvePath (string $settings_path= '', bool $try_env=true)
 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...
 

Protected Attributes

 $locked_values
 
 $deprecated
 
 $config_defaults
 
 $path_properties
 

Detailed Description

Definition at line 128 of file Config.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters
array$valuesInitial config values from Env/settings file

Definition at line 270 of file Config.php.

Member Function Documentation

Elgg\Config::__get ( string  $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$nameName
Returns
mixed null if does not exist

Definition at line 454 of file Config.php.

Elgg\Config::__isset ( string  $name)

Handle isset()

Parameters
string$nameName
Returns
bool

Definition at line 538 of file Config.php.

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$nameName
mixed$valueValue
Returns
void

Definition at line 520 of file Config.php.

Elgg\Config::__unset ( string  $name)

Handle unset()

Parameters
string$nameName
Returns
void

Definition at line 548 of file Config.php.

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

Build a config from default settings locations.

Parameters
string$settings_pathPath of settings file
bool$try_envIf path not given, try environment for 'ELGG_SETTINGS_FILE'
Returns
Config
Exceptions
ConfigurationException

Definition at line 304 of file Config.php.

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

Build a config from a file.

Parameters
string$pathPath of settings.php
string$reasonReturned reason for failure
Returns
bool|Config false on failure

Definition at line 326 of file Config.php.

Elgg\Config::getCookieConfig ( )

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

Returns
array

Definition at line 413 of file Config.php.

Elgg\Config::getInitialValue ( string  $name)

Get a value set at construction time.

Parameters
string$nameName
Returns
mixed null = not set

Definition at line 484 of file Config.php.

Elgg\Config::getValues ( )

Get all values.

Returns
array

Definition at line 404 of file Config.php.

Elgg\Config::hasInitialValue ( string  $name)

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

Parameters
string$nameName
Returns
bool

Definition at line 495 of file Config.php.

Elgg\Config::hasValue ( string  $name)

Test if we have a set value.

Parameters
string$nameName
Returns
bool

Definition at line 474 of file Config.php.

Elgg\Config::isLocked ( string  $name)

Is this value locked?

Parameters
string$nameName
Returns
bool

Definition at line 506 of file Config.php.

Elgg\Config::remove ( string  $name)

Removes a configuration setting from the database.

Parameters
string$nameConfiguration name
Returns
bool

Definition at line 593 of file Config.php.

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

Resolve settings path.

Parameters
string$settings_pathPath of settings file
bool$try_envIf path not given, try environment for 'ELGG_SETTINGS_FILE'
Returns
string

Definition at line 387 of file Config.php.

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

Save a configuration setting to the database.

Parameters
string$nameName (cannot be greater than 255 characters)
mixed$valueValue
Returns
bool

Definition at line 564 of file Config.php.

Elgg\Config::saveInitialValues ( array  $values)
protected

Stores the inital values.

Parameters
array$valuesThe initial values
Returns
void

Definition at line 286 of file Config.php.

Elgg\Config::wasWarnedLocked ( string  $name)
protected

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

Parameters
string$nameName
Returns
bool

Definition at line 611 of file Config.php.

Member Data Documentation

Elgg\Config::$config_defaults
protected
Initial value:
= [
'allow_phpinfo' => false

Definition at line 179 of file Config.php.

Elgg\Config::$deprecated
protected
Initial value:
= [
]

Definition at line 171 of file Config.php.

Elgg\Config::$locked_values
protected
Initial value:
= [
'assetroot',
'cacheroot',
'dataroot',
'installed',
'plugins_path',
'wwwroot',
]

Definition at line 157 of file Config.php.

Elgg\Config::$path_properties
protected
Initial value:
= [
'dataroot',
'cacheroot',
'assetroot',
]

Definition at line 237 of file Config.php.

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

Definition at line 248 of file Config.php.

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: