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\BaseObject;
  12 use Friendica\Core\Config\PConfiguration;
  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          * @brief Loads all configuration values of a user's config family into a cached storage.
  25          *
  26          * @param int    $uid The user_id
  27          * @param string $cat The category of the configuration value
  28          *
  29          * @return void
  30          */
  31         public static function load(int $uid, string $cat)
  32         {
  33                 self::getClass(PConfiguration::class)->load($uid, $cat);
  34         }
  35
  36         /**
  37          * @brief Get a particular user's config variable given the category name
  38          * ($cat) and a key.
  39          *
  40          * @param int     $uid           The user_id
  41          * @param string  $cat           The category of the configuration value
  42          * @param string  $key           The configuration key to query
  43          * @param mixed   $default_value optional, The value to return if key is not set (default: null)
  44          * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
  45          *
  46          * @return mixed Stored value or null if it does not exist
  47          */
  48         public static function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false)
  49         {
  50                 return self::getClass(PConfiguration::class)->get($uid, $cat, $key, $default_value, $refresh);
  51         }
  52
  53         /**
  54          * @brief Sets a configuration value for a user
  55          *
  56          * @param int    $uid    The user_id
  57          * @param string $cat    The category of the configuration value
  58          * @param string $key    The configuration key to set
  59          * @param mixed  $value  The value to store
  60          *
  61          * @return bool Operation success
  62          */
  63         public static function set(int $uid, string $cat, string $key, $value)
  64         {
  65                 return self::getClass(PConfiguration::class)->set($uid, $cat, $key, $value);
  66         }
  67
  68         /**
  69          * @brief Deletes the given key from the users's configuration.
  70          *
  71          * @param int    $uid The user_id
  72          * @param string $cat The category of the configuration value
  73          * @param string $key The configuration key to delete
  74          *
  75          * @return bool
  76          */
  77         public static function delete(int $uid, string $cat, string $key)
  78         {
  79                 return self::getClass(PConfiguration::class)->delete($uid, $cat, $key);
  80         }
  81 }