3 * User Configuration Class
5 * @file include/Core/PConfig.php
7 * @brief Contains the class with methods for user configuration
9 namespace Friendica\Core;
12 use Friendica\BaseObject;
14 require_once 'include/dba.php';
17 * @brief Management of user configuration storage
19 * Please do not store booleans - convert to 0/1 integer values
20 * The PConfig::get() functions return boolean false for keys that are unset,
21 * and this could lead to subtle bugs.
23 class PConfig extends BaseObject
26 * @var Friendica\Core\Config\IPConfigAdapter
28 private static $adapter = null;
30 public static function init($uid)
32 // Database isn't ready or populated yet
33 if (!(self::getApp()->mode & App::MODE_DBCONFIGAVAILABLE)) {
37 if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
38 self::$adapter = new Config\PreloadPConfigAdapter($uid);
40 self::$adapter = new Config\JITPConfigAdapter($uid);
45 * @brief Loads all configuration values of a user's config family into a cached storage.
47 * All configuration values of the given user are stored in global cache
48 * which is available under the global variable $a->config[$uid].
50 * @param string $uid The user_id
51 * @param string $family The category of the configuration value
55 public static function load($uid, $family)
57 // Database isn't ready or populated yet
58 if (!(self::getApp()->mode & App::MODE_DBCONFIGAVAILABLE)) {
62 if (empty(self::$adapter)) {
66 self::$adapter->load($uid, $family);
70 * @brief Get a particular user's config variable given the category name
71 * ($family) and a key.
73 * Get a particular user's config value from the given category ($family)
74 * and the $key from a cached storage in $a->config[$uid].
76 * @param string $uid The user_id
77 * @param string $family The category of the configuration value
78 * @param string $key The configuration key to query
79 * @param mixed $default_value optional, The value to return if key is not set (default: null)
80 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
82 * @return mixed Stored value or null if it does not exist
84 public static function get($uid, $family, $key, $default_value = null, $refresh = false)
86 // Database isn't ready or populated yet
87 if (!(self::getApp()->mode & App::MODE_DBCONFIGAVAILABLE)) {
91 if (empty(self::$adapter)) {
95 return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
99 * @brief Sets a configuration value for a user
101 * Stores a config value ($value) in the category ($family) under the key ($key)
102 * for the user_id $uid.
104 * @note Please do not store booleans - convert to 0/1 integer values!
106 * @param string $uid The user_id
107 * @param string $family The category of the configuration value
108 * @param string $key The configuration key to set
109 * @param string $value The value to store
111 * @return bool Operation success
113 public static function set($uid, $family, $key, $value)
115 // Database isn't ready or populated yet
116 if (!(self::getApp()->mode & App::MODE_DBCONFIGAVAILABLE)) {
120 if (empty(self::$adapter)) {
124 return self::$adapter->set($uid, $family, $key, $value);
128 * @brief Deletes the given key from the users's configuration.
130 * Removes the configured value from the stored cache in $a->config[$uid]
131 * and removes it from the database.
133 * @param string $uid The user_id
134 * @param string $family The category of the configuration value
135 * @param string $key The configuration key to delete
139 public static function delete($uid, $family, $key)
141 // Database isn't ready or populated yet
142 if (!(self::getApp()->mode & App::MODE_DBCONFIGAVAILABLE)) {
146 if (empty(self::$adapter)) {
150 return self::$adapter->delete($uid, $family, $key);