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\Config;
25 * Interface for accessing system wide configurations
31 * Loads all configuration values of family into a cached storage.
33 * All configuration values of the system are stored in the cache ( @param string $cat The category of the configuration value
37 function load(string $cat = 'config');
40 * Get a particular user's config variable given the category name
43 * Get a particular config value from the given category ($cat)
44 * and the $key from a cached storage either from the $this->configAdapter
45 * (@see IConfigAdapter) or from the $this->configCache (@see ConfigCache).
47 * @param string $cat The category of the configuration value
48 * @param string $key The configuration key to query
49 * @param mixed $default_value optional, The value to return if key is not set (default: null)
50 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
52 * @return mixed Stored value or null if it does not exist
54 function get(string $cat, string $key, $default_value = null, bool $refresh = false);
57 * Sets a configuration value for system config
59 * Stores a config value ($value) in the category ($cat) under the key ($key)
61 * Note: Please do not store booleans - convert to 0/1 integer values!
63 * @param string $cat The category of the configuration value
64 * @param string $key The configuration key to set
65 * @param mixed $value The value to store
67 * @return bool Operation success
69 function set(string $cat, string $key, $value);
72 * Deletes the given key from the system configuration.
74 * Removes the configured value from the stored cache in $this->configCache
75 * (@see ConfigCache) and removes it from the database (@see IConfigAdapter).
77 * @param string $cat The category of the configuration value
78 * @param string $key The configuration key to delete
82 function delete(string $cat, string $key);
85 * Returns the Config Cache