]> git.mxchange.org Git - friendica.git/blob - src/Core/PConfig.php
Fix PHPDoc comments project-wide
[friendica.git] / src / Core / PConfig.php
1 <?php
2 /**
3  * User Configuration Class
4  *
5  * @file include/Core/PConfig.php
6  *
7  * @brief Contains the class with methods for user configuration
8  */
9 namespace Friendica\Core;
10
11 use Friendica\App;
12 use Friendica\BaseObject;
13
14 /**
15  * @brief Management of user configuration storage
16  * Note:
17  * Please do not store booleans - convert to 0/1 integer values
18  * The PConfig::get() functions return boolean false for keys that are unset,
19  * and this could lead to subtle bugs.
20  */
21 class PConfig extends BaseObject
22 {
23         /**
24          * @var \Friendica\Core\Config\IPConfigAdapter
25          */
26         private static $adapter = null;
27
28         public static function init($uid)
29         {
30                 $a = self::getApp();
31
32                 // Database isn't ready or populated yet
33                 if (!$a->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
34                         return;
35                 }
36
37                 if ($a->getConfigValue('system', 'config_adapter') == 'preload') {
38                         self::$adapter = new Config\PreloadPConfigAdapter($uid);
39                 } else {
40                         self::$adapter = new Config\JITPConfigAdapter($uid);
41                 }
42         }
43
44         /**
45          * @brief Loads all configuration values of a user's config family into a cached storage.
46          *
47          * All configuration values of the given user are stored in global cache
48          * which is available under the global variable $a->config[$uid].
49          *
50          * @param string $uid    The user_id
51          * @param string $family The category of the configuration value
52          *
53          * @return void
54          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
55          */
56         public static function load($uid, $family)
57         {
58                 // Database isn't ready or populated yet
59                 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
60                         return;
61                 }
62
63                 if (empty(self::$adapter)) {
64                         self::init($uid);
65                 }
66
67                 self::$adapter->load($uid, $family);
68         }
69
70         /**
71          * @brief Get a particular user's config variable given the category name
72          * ($family) and a key.
73          *
74          * Get a particular user's config value from the given category ($family)
75          * and the $key from a cached storage in $a->config[$uid].
76          *
77          * @param string  $uid           The user_id
78          * @param string  $family        The category of the configuration value
79          * @param string  $key           The configuration key to query
80          * @param mixed   $default_value optional, The value to return if key is not set (default: null)
81          * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
82          *
83          * @return mixed Stored value or null if it does not exist
84          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
85          */
86         public static function get($uid, $family, $key, $default_value = null, $refresh = false)
87         {
88                 // Database isn't ready or populated yet
89                 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
90                         return;
91                 }
92
93                 if (empty(self::$adapter)) {
94                         self::init($uid);
95                 }
96
97                 return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
98         }
99
100         /**
101          * @brief Sets a configuration value for a user
102          *
103          * Stores a config value ($value) in the category ($family) under the key ($key)
104          * for the user_id $uid.
105          *
106          * @note  Please do not store booleans - convert to 0/1 integer values!
107          *
108          * @param string $uid    The user_id
109          * @param string $family The category of the configuration value
110          * @param string $key    The configuration key to set
111          * @param string $value  The value to store
112          *
113          * @return bool Operation success
114          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
115          */
116         public static function set($uid, $family, $key, $value)
117         {
118                 // Database isn't ready or populated yet
119                 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
120                         return false;
121                 }
122
123                 if (empty(self::$adapter)) {
124                         self::init($uid);
125                 }
126
127                 return self::$adapter->set($uid, $family, $key, $value);
128         }
129
130         /**
131          * @brief Deletes the given key from the users's configuration.
132          *
133          * Removes the configured value from the stored cache in $a->config[$uid]
134          * and removes it from the database.
135          *
136          * @param string $uid    The user_id
137          * @param string $family The category of the configuration value
138          * @param string $key    The configuration key to delete
139          *
140          * @return mixed
141          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
142          */
143         public static function delete($uid, $family, $key)
144         {
145                 // Database isn't ready or populated yet
146                 if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
147                         return false;
148                 }
149
150                 if (empty(self::$adapter)) {
151                         self::init($uid);
152                 }
153
154                 return self::$adapter->delete($uid, $family, $key);
155         }
156 }