abstract |
|---|
Base class for both site and user configuration data management
| Methods | ||||||
|---|---|---|---|---|---|---|
abstract
public
|
load(string $source, string $key)
This method must be overriden by classes extending this one
This method must be overriden by classes extending this one Parameters
Implemented by |
# | ||||
public
|
dump(): array
Return all config values
Return all config values Returnslist of config values |
# | ||||
public
|
del(string $name): bool
Delete a setting
Delete a setting Parameters
Returnstrue on success |
# | ||||
public
|
version(): float
Return a versoin number
Return a versoin number |
# | ||||
public
|
set(string $name, string $value): void
Set a config value
Set a config value Parameters
Overriden by |
# | ||||
public
|
reset_factory(): void
Reset config to default values
Reset config to default values Overriden by |
# | ||||
public
|
get(string $name, false|string $default = false): mixed
Return a config value if it exists
Return a config value if it exists Parameters
Returnsfound value, otherwise $default |
# | ||||
public
|
set_tz(): void
Set the timezone
Set the timezone |
# | ||||
public
|
shuffle(): void
Shuffle the config value order
Shuffle the config value order |
# | ||||
public
|
decode(string|false $data): mixed
Decode user settings with json_decode or unserialize depending
on the format
Decode user settings with json_decode or unserialize depending on the format Parameters
Returnsarray, or false on failure |
# | ||||
public
|
filter_servers(): array
Filter out default auth and SMTP servers so they don't get saved
to the permanent user config. These are dynamically…
Filter out default auth and SMTP servers so they don't get saved to the permanent user config. These are dynamically reloaded on login Returnsof items removed |
# | ||||
public
|
restore_servers(array $removed): void
Restore server definitions removed before saving
Restore server definitions removed before saving Parameters
|
# | ||||
| Properties | |||
|---|---|---|---|
protected
|
|
$source = ''
|
# |
protected
|
|
$config = ['version' => VERSION]
|
# |
public
|
|
$decrypt_failed = false
|
# |
public
|
|
$encrypted_str
|
# |
public
|
|
$save_on_login = false
|
# |