2016-06-06 04:22:14 -04:00
|
|
|
<?php
|
2017-11-19 14:15:25 -05:00
|
|
|
/**
|
2018-03-03 12:13:20 -05:00
|
|
|
* User Configuration Class
|
|
|
|
*
|
|
|
|
* @file include/Core/PConfig.php
|
|
|
|
*
|
|
|
|
* @brief Contains the class with methods for user configuration
|
2017-11-19 14:15:25 -05:00
|
|
|
*/
|
2016-06-10 05:52:01 -04:00
|
|
|
namespace Friendica\Core;
|
2016-12-13 09:24:44 -05:00
|
|
|
|
2019-07-21 14:24:16 -04:00
|
|
|
use Friendica\BaseObject;
|
|
|
|
use Friendica\Core\Config\PConfiguration;
|
|
|
|
|
2016-06-06 04:22:14 -04:00
|
|
|
/**
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief Management of user configuration storage
|
|
|
|
* Note:
|
|
|
|
* Please do not store booleans - convert to 0/1 integer values
|
|
|
|
* The PConfig::get() functions return boolean false for keys that are unset,
|
|
|
|
* and this could lead to subtle bugs.
|
2016-06-06 04:22:14 -04:00
|
|
|
*/
|
2019-07-21 14:24:16 -04:00
|
|
|
class PConfig extends BaseObject
|
2017-11-19 14:15:25 -05:00
|
|
|
{
|
2016-06-06 04:22:14 -04:00
|
|
|
/**
|
|
|
|
* @brief Loads all configuration values of a user's config family into a cached storage.
|
|
|
|
*
|
2019-07-15 21:48:28 -04:00
|
|
|
* @param int $uid The user_id
|
2019-02-10 13:52:21 -05:00
|
|
|
* @param string $cat The category of the configuration value
|
2017-11-19 14:15:25 -05:00
|
|
|
*
|
2016-06-06 04:22:14 -04:00
|
|
|
* @return void
|
|
|
|
*/
|
2019-07-16 07:45:24 -04:00
|
|
|
public static function load(int $uid, string $cat)
|
2017-11-19 14:15:25 -05:00
|
|
|
{
|
2019-07-21 14:24:16 -04:00
|
|
|
self::getClass(PConfiguration::class)->load($uid, $cat);
|
2016-06-06 04:22:14 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get a particular user's config variable given the category name
|
2019-02-10 13:52:21 -05:00
|
|
|
* ($cat) and a key.
|
2016-06-06 04:22:14 -04:00
|
|
|
*
|
2019-07-15 21:48:28 -04:00
|
|
|
* @param int $uid The user_id
|
2019-02-10 13:52:21 -05:00
|
|
|
* @param string $cat The category of the configuration value
|
2017-11-19 14:15:25 -05:00
|
|
|
* @param string $key The configuration key to query
|
|
|
|
* @param mixed $default_value optional, The value to return if key is not set (default: null)
|
|
|
|
* @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)
|
|
|
|
*
|
2016-06-08 15:52:10 -04:00
|
|
|
* @return mixed Stored value or null if it does not exist
|
2016-06-06 04:22:14 -04:00
|
|
|
*/
|
2019-07-16 07:45:24 -04:00
|
|
|
public static function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false)
|
2017-11-19 14:15:25 -05:00
|
|
|
{
|
2019-07-21 14:24:16 -04:00
|
|
|
return self::getClass(PConfiguration::class)->get($uid, $cat, $key, $default_value, $refresh);
|
2016-06-06 04:22:14 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Sets a configuration value for a user
|
|
|
|
*
|
2019-07-15 21:48:28 -04:00
|
|
|
* @param int $uid The user_id
|
2019-02-10 13:52:21 -05:00
|
|
|
* @param string $cat The category of the configuration value
|
2017-11-19 14:15:25 -05:00
|
|
|
* @param string $key The configuration key to set
|
2019-01-07 01:07:42 -05:00
|
|
|
* @param mixed $value The value to store
|
2017-11-19 14:15:25 -05:00
|
|
|
*
|
2018-07-18 02:32:35 -04:00
|
|
|
* @return bool Operation success
|
2016-06-06 04:22:14 -04:00
|
|
|
*/
|
2019-07-16 07:45:24 -04:00
|
|
|
public static function set(int $uid, string $cat, string $key, $value)
|
2017-11-19 14:15:25 -05:00
|
|
|
{
|
2019-07-21 14:24:16 -04:00
|
|
|
return self::getClass(PConfiguration::class)->set($uid, $cat, $key, $value);
|
2016-06-06 04:22:14 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Deletes the given key from the users's configuration.
|
|
|
|
*
|
2019-07-15 21:48:28 -04:00
|
|
|
* @param int $uid The user_id
|
2019-02-10 13:52:21 -05:00
|
|
|
* @param string $cat The category of the configuration value
|
|
|
|
* @param string $key The configuration key to delete
|
2017-11-19 14:15:25 -05:00
|
|
|
*
|
2019-02-10 13:52:21 -05:00
|
|
|
* @return bool
|
2016-06-06 04:22:14 -04:00
|
|
|
*/
|
2019-07-16 07:45:24 -04:00
|
|
|
public static function delete(int $uid, string $cat, string $key)
|
2017-11-19 14:15:25 -05:00
|
|
|
{
|
2019-07-21 14:24:16 -04:00
|
|
|
return self::getClass(PConfiguration::class)->delete($uid, $cat, $key);
|
2016-06-06 04:22:14 -04:00
|
|
|
}
|
|
|
|
}
|