|
static | factory (string $settings_path= '') |
| Build a config from default settings locations. More...
|
|
static | resolvePath (string $settings_path= '') |
| Resolve settings path. More...
|
|
Definition at line 139 of file Config.php.
Elgg\Config::__construct |
( |
array |
$values = [] | ) |
|
Constructor.
- Parameters
-
array | $values | Initial config values from Env/settings file |
Definition at line 285 of file Config.php.
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
-
- Returns
- mixed null if does not exist
Definition at line 454 of file Config.php.
Elgg\Config::__isset |
( |
string |
$name | ) |
|
Handle isset()
- Parameters
-
- 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 | $name | Name |
mixed | $value | Value |
- Returns
- void
Definition at line 520 of file Config.php.
Elgg\Config::__unset |
( |
string |
$name | ) |
|
Handle unset()
- Parameters
-
- Returns
- void
Definition at line 548 of file Config.php.
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 317 of file Config.php.
static Elgg\Config::fromFile |
( |
|
$path | ) |
|
|
staticprotected |
Build a config from a file.
- Parameters
-
string | $path | Path of settings.php |
- Returns
- Config
- Exceptions
-
Definition at line 331 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 |
( |
string |
$name | ) |
|
Get a value set at construction time.
- Parameters
-
- Returns
- mixed null = not set
Definition at line 484 of file Config.php.
Elgg\Config::getValues |
( |
| ) |
|
Get all values.
- Returns
- array
Definition at line 402 of file Config.php.
Elgg\Config::hasInitialValue |
( |
string |
$name | ) |
|
Was a value available at construction time? (From settings.php)
- Parameters
-
- Returns
- bool
Definition at line 495 of file Config.php.
Elgg\Config::hasValue |
( |
string |
$name | ) |
|
Test if we have a set value.
- Parameters
-
- Returns
- bool
Definition at line 474 of file Config.php.
Elgg\Config::isLocked |
( |
string |
$name | ) |
|
Is this value locked?
- Parameters
-
- Returns
- bool
Definition at line 506 of file Config.php.
Elgg\Config::remove |
( |
string |
$name | ) |
|
Removes a configuration setting from the database.
- Parameters
-
string | $name | Configuration name |
- Returns
- bool
Definition at line 593 of file Config.php.
static Elgg\Config::resolvePath |
( |
string |
$settings_path = '' | ) |
|
|
static |
Resolve settings path.
- Parameters
-
string | $settings_path | Path of settings file |
- Returns
- string
Definition at line 389 of file Config.php.
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 564 of file Config.php.
Elgg\Config::saveInitialValues |
( |
array |
$values | ) |
|
|
protected |
Stores the inital values.
- Parameters
-
array | $values | The initial values |
- Returns
- void
Definition at line 301 of file Config.php.
Elgg\Config::wasWarnedLocked |
( |
string |
$name | ) |
|
|
protected |
Log a read-only warning if the name is read-only.
- Parameters
-
- Returns
- bool
Definition at line 611 of file Config.php.
Elgg\Config::$config_defaults |
|
protected |
Initial value:= [
'allow_phpinfo' => false
Definition at line 190 of file Config.php.
Elgg\Config::$locked_values |
|
protected |
Initial value:= [
'assetroot',
'cacheroot',
'dataroot',
'installed',
'plugins_path',
'wwwroot',
]
Definition at line 168 of file Config.php.
Elgg\Config::$path_properties |
|
protected |
Initial value:= [
'dataroot',
'cacheroot',
'assetroot',
]
Definition at line 252 of file Config.php.
const Elgg\Config::ENTITY_TYPES = ['group', 'object', 'site', 'user'] |
const Elgg\Config::SENSITIVE_PROPERTIES |
Initial value:= [
'__site_secret__',
'db',
'dbhost',
'dbport',
'dbuser',
'dbpass',
'dbname',
]
Definition at line 270 of file Config.php.
The documentation for this class was generated from the following file: