<?php
-namespace Friendica\Core;
-
-use dba;
-use dbm;
-
/**
+ * User Configuration Class
+ *
* @file include/Core/PConfig.php
- * @brief contains the class with methods for the management
- * of the user configuration
+ *
+ * @brief Contains the class with methods for user configuration
*/
+namespace Friendica\Core;
/**
* @brief Management of user configuration storage
* The PConfig::get() functions return boolean false for keys that are unset,
* and this could lead to subtle bugs.
*/
-class PConfig {
+class PConfig
+{
+ /**
+ * @var Config\PConfiguration
+ */
+ private static $config;
- private static $in_db;
+ /**
+ * 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.
*
- * All configuration values of the given user are stored in global cache
- * which is available under the global variable $a->config[$uid].
+ * @param string $uid The user_id
+ * @param string $cat The category of the configuration value
*
- * @param string $uid
- * The user_id
- * @param string $family
- * The category of the configuration value
* @return void
*/
- public static function load($uid, $family) {
- $a = get_app();
-
- $r = dba::select('pconfig', array('v', 'k'), array('cat' => $family, 'uid' => $uid));
- if (dbm::is_result($r)) {
- while ($rr = dba::fetch($r)) {
- $k = $rr['k'];
- $a->config[$uid][$family][$k] = $rr['v'];
- self::$in_db[$uid][$family][$k] = true;
- }
- } else if ($family != 'config') {
- // Negative caching
- $a->config[$uid][$family] = "!<unset>!";
- }
+ public static function load($uid, $cat)
+ {
+ self::$config->load($uid, $cat);
}
/**
* @brief Get a particular user's config variable given the category name
- * ($family) and a key.
+ * ($cat) and a key.
*
- * Get a particular user's config value from the given category ($family)
- * and the $key from a cached storage in $a->config[$uid].
+ * @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)
*
- * @param string $uid
- * The user_id
- * @param string $family
- * 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, $family, $key, $default_value = null, $refresh = false) {
-
- $a = get_app();
-
- if (!$refresh) {
- // Looking if the whole family isn't set
- if (isset($a->config[$uid][$family])) {
- if ($a->config[$uid][$family] === '!<unset>!') {
- return $default_value;
- }
- }
-
- if (isset($a->config[$uid][$family][$key])) {
- if ($a->config[$uid][$family][$key] === '!<unset>!') {
- return $default_value;
- }
- return $a->config[$uid][$family][$key];
- }
- }
-
- $ret = dba::select('pconfig', array('v'), array('uid' => $uid, 'cat' => $family, 'k' => $key), array('limit' => 1));
- if (dbm::is_result($ret)) {
- $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
- $a->config[$uid][$family][$key] = $val;
- self::$in_db[$uid][$family][$key] = true;
-
- return $val;
- } else {
- $a->config[$uid][$family][$key] = '!<unset>!';
- self::$in_db[$uid][$family][$key] = false;
-
- return $default_value;
- }
+ 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
*
- * Stores a config value ($value) in the category ($family) under the key ($key)
- * for the user_id $uid.
+ * @note Please do not store booleans - convert to 0/1 integer values!
*
- * @note Please do not store booleans - convert to 0/1 integer values!
+ * @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
*
- * @param string $uid
- * The user_id
- * @param string $family
- * The category of the configuration value
- * @param string $key
- * The configuration key to set
- * @param string $value
- * The value to store
- * @return mixed Stored $value or false
+ * @return bool Operation success
*/
- public static function set($uid, $family, $key, $value) {
-
- $a = get_app();
-
- // We store our setting values in a string variable.
- // So we have to do the conversion here so that the compare below works.
- // The exception are array values.
- $dbvalue = (!is_array($value) ? (string)$value : $value);
-
- $stored = self::get($uid, $family, $key, null, true);
-
- if (($stored === $dbvalue) && self::$in_db[$uid][$family][$key]) {
- return true;
- }
-
- $a->config[$uid][$family][$key] = $dbvalue;
-
- // manage array value
- $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
-
- dba::update('pconfig', array('v' => $dbvalue), array('uid' => $uid, 'cat' => $family, 'k' => $key), true);
-
- if ($ret) {
- self::$in_db[$uid][$family][$key] = true;
- return $value;
- }
- return $ret;
+ 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.
*
- * Removes the configured value from the stored cache in $a->config[$uid]
- * and removes it from the database.
- *
* @param string $uid The user_id
- * @param string $family
- * The category of the configuration value
- * @param string $key
- * The configuration key to delete
- * @return mixed
+ * @param string $cat The category of the configuration value
+ * @param string $key The configuration key to delete
+ *
+ * @return bool
*/
- public static function delete($uid,$family,$key) {
-
- $a = get_app();
-
- if (x($a->config[$uid][$family], $key)) {
- unset($a->config[$uid][$family][$key]);
- unset(self::$in_db[$uid][$family][$key]);
- }
-
- $ret = dba::delete('pconfig', array('uid' => $uid, 'cat' => $family, 'k' => $key));
-
- return $ret;
+ public static function delete($uid, $cat, $key)
+ {
+ return self::$config->delete($uid, $cat, $key);
}
}
projects / friendica.git / blobdiff