<?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\IPConfigAdapter
+ */
+ private static $adapter;
- private static $in_db;
+ /**
+ * @var Config\IPConfigCache
+ */
+ private static $cache;
+
+ /**
+ * Initialize the config with only the cache
+ *
+ * @param Config\IPConfigCache $cache The configuration cache
+ */
+ public static function init(Config\IPConfigCache $cache)
+ {
+ self::$cache = $cache;
+ }
+
+ /**
+ * Add the adapter for DB-backend
+ *
+ * @param Config\IPConfigAdapter $adapter
+ */
+ public static function setAdapter(Config\IPConfigAdapter $adapter)
+ {
+ self::$adapter = $adapter;
+ }
/**
* @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].
+ * All configuration values of the given user are stored with the $uid in
+ * the cache ( @see IPConfigCache )
+ *
+ * @param string $uid The user_id
+ * @param string $family 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),
- array("order" => array('uid', 'cat', 'k')));
- 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, $family)
+ {
+ if (!isset(self::$adapter)) {
+ return;
}
+
+ self::$adapter->load($uid, $family);
}
/**
* ($family) 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].
+ * and the $key with the $uid from a cached storage either from the self::$adapter
+ * (@see IConfigAdapter ) or from the static::$cache (@see IConfigCache ).
+ *
+ * @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)
*
- * @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];
- }
+ public static function get($uid, $family, $key, $default_value = null, $refresh = false)
+ {
+ if (!isset(self::$adapter)) {
+ return self::$cache->getP($uid, $family, $key, $default_value);
}
- $ret = dba::select('pconfig', array('v'), array('uid' => $uid, 'cat' => $family, 'k' => $key),
- array("order" => array('uid', 'cat', 'k'), '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;
- }
+ return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
}
/**
* 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 $family 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);
-
- if (is_null($stored) || !self::$in_db[$uid][$family][$key]) {
- $ret = q("INSERT INTO `pconfig` (`uid`, `cat`, `k`, `v`) VALUES (%d, '%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
- intval($uid),
- dbesc($family),
- dbesc($key),
- dbesc($dbvalue),
- dbesc($dbvalue)
- );
- } else {
- $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
- dbesc($dbvalue),
- intval($uid),
- dbesc($family),
- dbesc($key)
- );
+ public static function set($uid, $family, $key, $value)
+ {
+ if (!isset(self::$adapter)) {
+ return self::$cache->setP($uid, $family, $key, $value);
}
- if ($ret) {
- self::$in_db[$uid][$family][$key] = true;
- return $value;
- }
- return $ret;
+ return self::$adapter->set($uid, $family, $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.
+ * Removes the configured value from the stored cache in self::$config
+ * (@see ConfigCache ) and removes it from the database (@see IConfigAdapter )
+ * with the given $uid.
+ *
+ * @param string $uid The user_id
+ * @param string $family The category of the configuration value
+ * @param string $key The configuration key to delete
*
- * @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
*/
- 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]);
+ public static function delete($uid, $family, $key)
+ {
+ if (!isset(self::$adapter)) {
+ return self::$cache->deleteP($uid, $family, $key);
}
- $ret = dba::delete('pconfig', array('uid' => $uid, 'cat' => $family, 'k' => $key));
-
- return $ret;
+ return self::$adapter->delete($uid, $family, $key);
}
}
projects / friendica.git / blobdiff