3 * @copyright Copyright (C) 2010-2023, the Friendica project
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\Config\Capability;
24 use Friendica\Core\Config\Exception\ConfigPersistenceException;
25 use Friendica\Core\Config\ValueObject\Cache;
28 * Interface for accessing system-wide configurations
30 interface IManageConfigValues
33 * Loads all configuration values of family into a cached storage.
35 * All configuration values of the system are stored in the cache.
37 * @param string $cat The category of the configuration value
41 * @throws ConfigPersistenceException In case the persistence layer throws errors
43 public function load(string $cat = 'config');
46 * Get a particular user's config variable given the category name
49 * Get a particular config value from the given category ($cat)
50 * and the $key from a cached storage either from the database or from the cache.
52 * @param string $cat The category of the configuration value
53 * @param string $key The configuration key to query
54 * @param mixed $default_value Deprecated, use `Config->get($cat, $key, null, $refresh) ?? $default_value` instead
55 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
57 * @return mixed Stored value or null if it does not exist
59 * @throws ConfigPersistenceException In case the persistence layer throws errors
62 public function get(string $cat, string $key, $default_value = null, bool $refresh = false);
65 * Sets a configuration value for system config
67 * Stores a config value ($value) in the category ($cat) under the key ($key)
69 * Note: Please do not store booleans - convert to 0/1 integer values!
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
74 * @param bool $autosave If true, implicit save the value
76 * @return bool Operation success
78 * @throws ConfigPersistenceException In case the persistence layer throws errors
80 public function set(string $cat, string $key, $value, bool $autosave = true): bool;
83 * Save back the overridden values of the config cache
85 public function save();
88 * Deletes the given key from the system configuration.
90 * Removes the configured value from the stored cache in the cache and removes it from the database.
92 * @param string $cat The category of the configuration value
93 * @param string $key The configuration key to delete
94 * @param bool $autosave If true, implicit save the value
98 * @throws ConfigPersistenceException In case the persistence layer throws errors
101 public function delete(string $cat, string $key, bool $autosave = true): bool;
104 * Returns the Config Cache
108 public function getCache(): Cache;