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 * @brief Arbitrary system configuration storage
15 * If we ever would decide to return exactly the variable type as entered,
16 * we will have fun with the additional features. :-)
21 * @var Config\IConfigAdapter
23 private static $adapter;
26 * @var Config\IConfigCache
28 private static $config;
31 * Initialize the config with only the cache
33 * @param Config\IConfigCache $config The configuration cache
35 public static function init($config)
37 self::$config = $config;
41 * Add the adapter for DB-backend
43 * @param Config\IConfigAdapter $adapter
45 public static function setAdapter($adapter)
47 self::$adapter = $adapter;
51 * @brief Loads all configuration values of family into a cached storage.
53 * All configuration values of the system are stored in global cache
54 * which is available under the global variable self::$config
56 * @param string $family The category of the configuration value
60 public static function load($family = "config")
62 if (!isset(self::$adapter)) {
66 self::$adapter->load($family);
70 * @brief Get a particular user's config variable given the category name
71 * ($family) and a key.
73 * Get a particular config value from the given category ($family)
74 * and the $key from a cached storage in static::config[$uid].
75 * $instore is only used by the set_config function
76 * to determine if the key already exists in the DB
77 * If a key is found in the DB but doesn't exist in
78 * local config cache, pull it into the cache so we don't have
79 * to hit the DB again for this item.
81 * @param string $family The category of the configuration value
82 * @param string $key The configuration key to query
83 * @param mixed $default_value optional, The value to return if key is not set (default: null)
84 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
86 * @return mixed Stored value or null if it does not exist
88 public static function get($family, $key, $default_value = null, $refresh = false)
90 if (!isset(self::$adapter)) {
91 return self::$config->get($family, $key, $default_value);
94 return self::$adapter->get($family, $key, $default_value, $refresh);
98 * @brief Sets a configuration value for system config
100 * Stores a config value ($value) in the category ($family) under the key ($key)
101 * for the user_id $uid.
103 * Note: Please do not store booleans - convert to 0/1 integer values!
105 * @param string $family The category of the configuration value
106 * @param string $key The configuration key to set
107 * @param mixed $value The value to store
109 * @return bool Operation success
111 public static function set($family, $key, $value)
113 if (!isset(self::$adapter)) {
114 self::$config->set($family, $key, $value);
118 return self::$adapter->set($family, $key, $value);
122 * @brief Deletes the given key from the system configuration.
124 * Removes the configured value from the stored cache in Config::$config
125 * and removes it from the database.
127 * @param string $family The category of the configuration value
128 * @param string $key The configuration key to delete
132 public static function delete($family, $key)
134 if (!isset(self::$adapter)) {
135 self::$config->delete($family, $key);
138 return self::$adapter->delete($family, $key);