3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core\PConfig;
25 * Interface for accessing user specific configurations
31 * Loads all configuration values of a user's config family into a cached storage.
33 * All configuration values of the given user are stored with the $uid in the cache
35 * @param int $uid The user_id
36 * @param string $cat The category of the configuration value
42 function load(int $uid, string $cat = 'config');
45 * Get a particular user's config variable given the category name
48 * Get a particular user's config value from the given category ($cat)
49 * and the $key with the $uid from a cached storage either from the $this->configAdapter
50 * (@see IConfigAdapter) or from the $this->configCache (@see PConfigCache).
52 * @param int $uid The user_id
53 * @param string $cat The category of the configuration value
54 * @param string $key The configuration key to query
55 * @param mixed $default_value optional, The value to return if key is not set (default: null)
56 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
58 * @return mixed Stored value or null if it does not exist
60 function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false);
63 * Sets a configuration value for a user
65 * Stores a config value ($value) in the category ($family) under the key ($key)
66 * for the user_id $uid.
68 * @note Please do not store booleans - convert to 0/1 integer values!
70 * @param int $uid The user_id
71 * @param string $cat The category of the configuration value
72 * @param string $key The configuration key to set
73 * @param mixed $value The value to store
75 * @return bool Operation success
77 function set(int $uid, string $cat, string $key, $value);
80 * Deletes the given key from the users's configuration.
82 * Removes the configured value from the stored cache in $this->configCache
83 * (@see ConfigCache) and removes it from the database (@see IConfigAdapter)
84 * with the given $uid.
86 * @param int $uid The user_id
87 * @param string $cat The category of the configuration value
88 * @param string $key The configuration key to delete
92 function delete(int $uid, string $cat, string $key);
96 * Returns the Config Cache