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\Core\Config\IPConfigCache;
  12
  13 /**
  14  * @brief Management of user configuration storage
  15  * Note:
  16  * Please do not store booleans - convert to 0/1 integer values
  17  * The PConfig::get() functions return boolean false for keys that are unset,
  18  * and this could lead to subtle bugs.
  19  */
  20 class PConfig
  21 {
  22         /**
  23          * @var \Friendica\Core\Config\IPConfigAdapter
  24          */
  25         private static $adapter;
  26
  27         /**
  28          * @var IPConfigCache
  29          */
  30         private static $config;
  31
  32         /**
  33          * Initialize the config with only the cache
  34          *
  35          * @param IPConfigCache $config  The configuration cache
  36          */
  37         public static function init($config)
  38         {
  39                 self::$config  = $config;
  40         }
  41
  42         /**
  43          * Add the adapter for DB-backend
  44          *
  45          * @param $adapter
  46          */
  47         public static function setAdapter($adapter)
  48         {
  49                 self::$adapter = $adapter;
  50         }
  51
  52         /**
  53          * @brief Loads all configuration values of a user's config family into a cached storage.
  54          *
  55          * All configuration values of the given user are stored in global cache
  56          * which is available under the global variable self::$config[$uid].
  57          *
  58          * @param string $uid    The user_id
  59          * @param string $family The category of the configuration value
  60          *
  61          * @return void
  62          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  63          */
  64         public static function load($uid, $family)
  65         {
  66                 if (!isset(self::$adapter)) {
  67                         return;
  68                 }
  69
  70                 self::$adapter->load($uid, $family);
  71         }
  72
  73         /**
  74          * @brief Get a particular user's config variable given the category name
  75          * ($family) and a key.
  76          *
  77          * Get a particular user's config value from the given category ($family)
  78          * and the $key from a cached storage in self::$config[$uid].
  79          *
  80          * @param string  $uid           The user_id
  81          * @param string  $family        The category of the configuration value
  82          * @param string  $key           The configuration key to query
  83          * @param mixed   $default_value optional, The value to return if key is not set (default: null)
  84          * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
  85          *
  86          * @return mixed Stored value or null if it does not exist
  87          */
  88         public static function get($uid, $family, $key, $default_value = null, $refresh = false)
  89         {
  90                 if (!isset(self::$adapter)) {
  91                         return self::$config->getP($uid, $family, $key, $default_value);
  92                 }
  93
  94                 return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
  95         }
  96
  97         /**
  98          * @brief Sets a configuration value for a user
  99          *
 100          * Stores a config value ($value) in the category ($family) under the key ($key)
 101          * for the user_id $uid.
 102          *
 103          * @note  Please do not store booleans - convert to 0/1 integer values!
 104          *
 105          * @param string $uid    The user_id
 106          * @param string $family The category of the configuration value
 107          * @param string $key    The configuration key to set
 108          * @param mixed  $value  The value to store
 109          *
 110          * @return bool Operation success
 111          */
 112         public static function set($uid, $family, $key, $value)
 113         {
 114                 if (!isset(self::$adapter)) {
 115                         return self::$config->setP($uid, $family, $key, $value);
 116                 }
 117
 118                 return self::$adapter->set($uid, $family, $key, $value);
 119         }
 120
 121         /**
 122          * @brief Deletes the given key from the users's configuration.
 123          *
 124          * Removes the configured value from the stored cache in self::$config[$uid]
 125          * and removes it from the database.
 126          *
 127          * @param string $uid    The user_id
 128          * @param string $family The category of the configuration value
 129          * @param string $key    The configuration key to delete
 130          *
 131          * @return mixed
 132          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 133          */
 134         public static function delete($uid, $family, $key)
 135         {
 136                 if (!isset(self::$adapter)) {
 137                         return self::$config->deleteP($uid, $family, $key);
 138                 }
 139
 140                 return self::$adapter->delete($uid, $family, $key);
 141         }
 142 }