Elgg  Version 4.x
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...
 
 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...
 

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

Public Attributes

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

Protected Member Functions

 saveInitialValues (array $values)
 Stores the inital values. More...
 

Protected Attributes

 $config_defaults
 

Detailed Description

Definition at line 145 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 241 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$nameName
Returns
mixed null if does not exist

Definition at line 452 of file Config.php.

Elgg\Config::__isset (   $name)

Handle isset()

Parameters
string$nameName
Returns
bool

Definition at line 535 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$nameName
mixed$valueValue
Returns
void

Definition at line 522 of file Config.php.

Elgg\Config::__unset (   $name)

Handle unset()

Parameters
string$nameName
Returns
void

Definition at line 545 of file Config.php.

static Elgg\Config::factory (   $settings_path = '',
  $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 $_ENV['ELGG_SETTINGS_FILE']
Returns
Config
Exceptions
ConfigurationException

Definition at line 285 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 309 of file Config.php.

Elgg\Config::getCookieConfig ( )

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

Returns
array

Definition at line 411 of file Config.php.

Elgg\Config::getInitialValue (   $name)

Get a value set at construction time.

Parameters
string$nameName
Returns
mixed null = not set

Definition at line 477 of file Config.php.

Elgg\Config::getValues ( )

Get all values.

Returns
array

Definition at line 402 of file Config.php.

Elgg\Config::hasInitialValue (   $name)

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

Parameters
string$nameName
Returns
bool

Definition at line 488 of file Config.php.

Elgg\Config::hasValue (   $name)

Test if we have a set value.

Parameters
string$nameName
Returns
bool

Definition at line 467 of file Config.php.

Elgg\Config::isLocked (   $name)

Is this value locked?

Parameters
string$nameName
Returns
bool

Definition at line 509 of file Config.php.

Elgg\Config::lock (   $name)

Make a value read-only.

Parameters
string$nameName
Returns
void

Definition at line 498 of file Config.php.

Elgg\Config::mergeValues ( array  $values)

Set an array of values.

Parameters
array$valuesValues
Returns
void

Definition at line 391 of file Config.php.

Elgg\Config::remove (   $name)

Removes a configuration setting from the database.

Parameters
string$nameConfiguration name
Returns
bool

Definition at line 590 of file Config.php.

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

Resolve settings path.

Parameters
string$settings_pathPath of settings file
bool$try_envIf path not given, try $_ENV['ELGG_SETTINGS_FILE']
Returns
string

Definition at line 373 of file Config.php.

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

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

Stores the inital values.

Parameters
array$valuesThe initial values
Returns
void

Definition at line 257 of file Config.php.

Member Data Documentation

Elgg\Config::$config_defaults
protected
Initial value:
= [
'batch_run_time_in_secs' => 4

Definition at line 189 of file Config.php.

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

Definition at line 234 of file Config.php.


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