3 * System Configuration Class
5 * @file include/Core/Config.php
7 * @brief Contains the class with methods for system configuration
9 namespace Friendica\Core;
12 use Friendica\BaseObject;
15 * @brief Arbitrary system configuration storage
18 * If we ever would decide to return exactly the variable type as entered,
19 * we will have fun with the additional features. :-)
21 class Config extends BaseObject
24 * @var \Friendica\Core\Config\IConfigAdapter
26 private static $adapter = null;
28 public static function init()
30 // Database isn't ready or populated yet
31 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
35 if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
36 self::$adapter = new Config\PreloadConfigAdapter();
38 self::$adapter = new Config\JITConfigAdapter();
43 * @brief Loads all configuration values of family into a cached storage.
45 * All configuration values of the system are stored in global cache
46 * which is available under the global variable $a->config
48 * @param string $family The category of the configuration value
51 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
53 public static function load($family = "config")
55 // Database isn't ready or populated yet
56 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
60 if (empty(self::$adapter)) {
64 self::$adapter->load($family);
68 * @brief Get a particular user's config variable given the category name
69 * ($family) and a key.
71 * Get a particular config value from the given category ($family)
72 * and the $key from a cached storage in $a->config[$uid].
73 * $instore is only used by the set_config function
74 * to determine if the key already exists in the DB
75 * If a key is found in the DB but doesn't exist in
76 * local config cache, pull it into the cache so we don't have
77 * to hit the DB again for this item.
79 * @param string $family The category of the configuration value
80 * @param string $key The configuration key to query
81 * @param mixed $default_value optional, The value to return if key is not set (default: null)
82 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
84 * @return mixed Stored value or null if it does not exist
85 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
87 public static function get($family, $key, $default_value = null, $refresh = false)
89 // Database isn't ready or populated yet, fallback to file config
90 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
91 return self::getApp()->getConfigValue($family, $key, $default_value);
94 if (empty(self::$adapter)) {
98 return self::$adapter->get($family, $key, $default_value, $refresh);
102 * @brief Sets a configuration value for system config
104 * Stores a config value ($value) in the category ($family) under the key ($key)
105 * for the user_id $uid.
107 * Note: Please do not store booleans - convert to 0/1 integer values!
109 * @param string $family The category of the configuration value
110 * @param string $key The configuration key to set
111 * @param mixed $value The value to store
113 * @return bool Operation success
114 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
116 public static function set($family, $key, $value)
118 // Database isn't ready or populated yet
119 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
123 if (empty(self::$adapter)) {
127 return self::$adapter->set($family, $key, $value);
131 * @brief Deletes the given key from the system configuration.
133 * Removes the configured value from the stored cache in $a->config
134 * and removes it from the database.
136 * @param string $family The category of the configuration value
137 * @param string $key The configuration key to delete
140 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
142 public static function delete($family, $key)
144 // Database isn't ready or populated yet
145 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
149 if (empty(self::$adapter)) {
153 return self::$adapter->delete($family, $key);