3 namespace Friendica\Core\Config;
6 * This class is responsible for the user-specific configuration values in Friendica
7 * The values are set through the Config-DB-Table (per Config-DB-adapter @see Adapter\IPConfigAdapter )
9 * The configuration cache (@see Cache\IPConfigCache ) is used for temporary caching of database calls. This will
10 * increase the performance.
15 * @var Cache\IPConfigCache
20 * @var Adapter\IPConfigAdapter
22 private $configAdapter;
25 * @param Cache\IPConfigCache $configCache The configuration cache
26 * @param Adapter\IPConfigAdapter $configAdapter The configuration DB-backend
28 public function __construct(Cache\IPConfigCache $configCache, Adapter\IPConfigAdapter $configAdapter)
30 $this->configCache = $configCache;
31 $this->configAdapter = $configAdapter;
35 * @brief Loads all configuration values of a user's config family into a cached storage.
37 * All configuration values of the given user are stored with the $uid in
38 * the cache ( @see IPConfigCache )
40 * @param string $uid The user_id
41 * @param string $cat The category of the configuration value
45 public function load($uid, $cat = 'config')
47 // If not connected, do nothing
48 if (!$this->configAdapter->isConnected()) {
52 // load the whole category out of the DB into the cache
53 $this->configCache->loadP($uid, $this->configAdapter->load($uid, $cat));
57 * @brief Get a particular user's config variable given the category name
60 * Get a particular user's config value from the given category ($cat)
61 * and the $key with the $uid from a cached storage either from the $this->configAdapter
62 * (@see IConfigAdapter ) or from the $this->configCache (@see IConfigCache ).
64 * @param string $uid The user_id
65 * @param string $cat The category of the configuration value
66 * @param string $key The configuration key to query
67 * @param mixed $default_value optional, The value to return if key is not set (default: null)
68 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
70 * @return mixed Stored value or null if it does not exist
72 public function get($uid, $cat, $key, $default_value = null, $refresh = false)
74 // if the value isn't loaded or refresh is needed, load it to the cache
75 if ($this->configAdapter->isConnected() &&
76 (!$this->configAdapter->isLoaded($uid, $cat, $key) ||
78 $dbValue = $this->configAdapter->get($uid, $cat, $key);
80 if ($dbValue !== '!<unset>!') {
81 $this->configCache->setP($uid, $cat, $key, $dbValue);
86 // use the config cache for return
87 if ($this->configCache->hasP($uid, $cat, $key)) {
88 return $this->configCache->getP($uid, $cat, $key);
90 return $default_value;
95 * @brief Sets a configuration value for a user
97 * Stores a config value ($value) in the category ($family) under the key ($key)
98 * for the user_id $uid.
100 * @note Please do not store booleans - convert to 0/1 integer values!
102 * @param string $uid The user_id
103 * @param string $cat The category of the configuration value
104 * @param string $key The configuration key to set
105 * @param mixed $value The value to store
107 * @return bool Operation success
109 public function set($uid, $cat, $key, $value)
111 // set the cache first
112 $cached = $this->configCache->setP($uid, $cat, $key, $value);
114 // If there is no connected adapter, we're finished
115 if (!$this->configAdapter->isConnected()) {
119 $stored = $this->configAdapter->set($uid, $cat, $key, $value);
121 return $cached && $stored;
125 * @brief Deletes the given key from the users's configuration.
127 * Removes the configured value from the stored cache in $this->configCache
128 * (@see ConfigCache ) and removes it from the database (@see IConfigAdapter )
129 * with the given $uid.
131 * @param string $uid The user_id
132 * @param string $cat The category of the configuration value
133 * @param string $key The configuration key to delete
137 public function delete($uid, $cat, $key)
139 $cacheRemoved = $this->configCache->deleteP($uid, $cat, $key);
141 if (!$this->configAdapter->isConnected()) {
142 return $cacheRemoved;
145 $storeRemoved = $this->configAdapter->delete($uid, $cat, $key);
147 return $cacheRemoved || $storeRemoved;