3 * System Configuration Class
5 * @file include/Core/Config.php
7 * @brief Contains the class with methods for system configuration
9 namespace Friendica\Core;
11 use Friendica\BaseObject;
12 use Friendica\Core\Config;
14 require_once 'include/dba.php';
17 * @brief Arbitrary system configuration storage
20 * If we ever would decide to return exactly the variable type as entered,
21 * we will have fun with the additional features. :-)
23 class Config extends BaseObject
26 * @var Friendica\Core\Config\IConfigAdapter
28 private static $adapter = null;
30 public static function init()
32 if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
33 self::$adapter = new Config\PreloadConfigAdapter();
35 self::$adapter = new Config\JITConfigAdapter();
40 * @brief Loads all configuration values of family into a cached storage.
42 * All configuration values of the system are stored in global cache
43 * which is available under the global variable $a->config
45 * @param string $family The category of the configuration value
49 public static function load($family = "config")
51 if (empty(self::$adapter)) {
55 self::$adapter->load($family);
59 * @brief Get a particular user's config variable given the category name
60 * ($family) and a key.
62 * Get a particular config value from the given category ($family)
63 * and the $key from a cached storage in $a->config[$uid].
64 * $instore is only used by the set_config function
65 * to determine if the key already exists in the DB
66 * If a key is found in the DB but doesn't exist in
67 * local config cache, pull it into the cache so we don't have
68 * to hit the DB again for this item.
70 * @param string $family The category of the configuration value
71 * @param string $key The configuration key to query
72 * @param mixed $default_value optional, The value to return if key is not set (default: null)
73 * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
75 * @return mixed Stored value or null if it does not exist
77 public static function get($family, $key, $default_value = null, $refresh = false)
79 if (empty(self::$adapter)) {
83 return self::$adapter->get($family, $key, $default_value, $refresh);
87 * @brief Sets a configuration value for system config
89 * Stores a config value ($value) in the category ($family) under the key ($key)
90 * for the user_id $uid.
92 * Note: Please do not store booleans - convert to 0/1 integer values!
94 * @param string $family The category of the configuration value
95 * @param string $key The configuration key to set
96 * @param mixed $value The value to store
98 * @return mixed Stored $value or false if the database update failed
100 public static function set($family, $key, $value)
102 if (empty(self::$adapter)) {
106 return self::$adapter->set($family, $key, $value);
110 * @brief Deletes the given key from the system configuration.
112 * Removes the configured value from the stored cache in $a->config
113 * and removes it from the database.
115 * @param string $family The category of the configuration value
116 * @param string $key The configuration key to delete
120 public static function delete($family, $key)
122 if (empty(self::$adapter)) {
126 return self::$adapter->delete($family, $key);