mirror of
https://github.com/friendica/friendica
synced 2024-12-26 09:20:17 +00:00
8c3aebc376
- replaced usage of "!<unset>!" with null-returns - fixed bool settings (0/1) - fixed overriding config-values - fixed basepath problems
93 lines
2.5 KiB
PHP
93 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* User Configuration Class
|
|
*
|
|
* @file include/Core/PConfig.php
|
|
*
|
|
* @brief Contains the class with methods for user configuration
|
|
*/
|
|
namespace Friendica\Core;
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
class PConfig
|
|
{
|
|
/**
|
|
* @var Config\PConfiguration
|
|
*/
|
|
private static $config;
|
|
|
|
/**
|
|
* Initialize the config with only the cache
|
|
*
|
|
* @param Config\PConfiguration $config The configuration cache
|
|
*/
|
|
public static function init(Config\PConfiguration $config)
|
|
{
|
|
self::$config = $config;
|
|
}
|
|
|
|
/**
|
|
* @brief Loads all configuration values of a user's config family into a cached storage.
|
|
*
|
|
* @param string $uid The user_id
|
|
* @param string $cat The category of the configuration value
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function load($uid, $cat)
|
|
{
|
|
self::$config->load($uid, $cat);
|
|
}
|
|
|
|
/**
|
|
* @brief Get a particular user's config variable given the category name
|
|
* ($cat) and a key.
|
|
*
|
|
* @param string $uid The user_id
|
|
* @param string $cat The category of the configuration value
|
|
* @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)
|
|
*
|
|
* @return mixed Stored value or null if it does not exist
|
|
*/
|
|
public static function get($uid, $cat, $key, $default_value = null, $refresh = false)
|
|
{
|
|
return self::$config->get($uid, $cat, $key, $default_value, $refresh);
|
|
}
|
|
|
|
/**
|
|
* @brief Sets a configuration value for a user
|
|
*
|
|
* @param string $uid The user_id
|
|
* @param string $cat The category of the configuration value
|
|
* @param string $key The configuration key to set
|
|
* @param mixed $value The value to store
|
|
*
|
|
* @return bool Operation success
|
|
*/
|
|
public static function set($uid, $cat, $key, $value)
|
|
{
|
|
return self::$config->set($uid, $cat, $key, $value);
|
|
}
|
|
|
|
/**
|
|
* @brief Deletes the given key from the users's configuration.
|
|
*
|
|
* @param string $uid The user_id
|
|
* @param string $cat The category of the configuration value
|
|
* @param string $key The configuration key to delete
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function delete($uid, $cat, $key)
|
|
{
|
|
return self::$config->delete($uid, $cat, $key);
|
|
}
|
|
}
|