X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=include%2Fconfig.php;h=c51db4ec7b1f7fc9f550bdf3818014553a5e9ec1;hb=b50769b6d09549e1641bab1813087fd928602129;hp=c999b76f2ebc4f21be6112e6feb326a1956cc60c;hpb=4bee1859be5fbf46ecc19728a908e31b4e9b09b6;p=friendica.git

diff --git a/include/config.php b/include/config.php
index c999b76f2e..c51db4ec7b 100644
--- a/include/config.php
+++ b/include/config.php
@@ -1,7 +1,8 @@
 <?php
 /**
- *
- * Arbitrary configuration storage
+ * @file include/config.php
+ * 
+ *  @brief (Deprecated) Arbitrary configuration storage
  * Note:
  * Please do not store booleans - convert to 0/1 integer values
  * The get_?config() functions return boolean false for keys that are unset,
@@ -9,219 +10,142 @@
  *
  * There are a few places in the code (such as the admin panel) where boolean
  * configurations need to be fixed as of 10/08/2011.
- *
- * @package config;
  */
 
+use \Friendica\Core\Config;
+use \Friendica\Core\PConfig;
 
 /**
- * retrieve a "family" of config variables
- * from database to cached storage
+ * @brief (Deprecated) Loads all configuration values of family into a cached storage.
+ *
+ * Note: This function is deprecated. Use Config::load() instead.
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @return void
  */
-if(! function_exists('load_config')) {
-	function load_config($family) {
-		global $a;
-		$r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
-				dbesc($family)
-		);
-		if(count($r)) {
-			foreach($r as $rr) {
-				$k = $rr['k'];
-				if ($rr['cat'] === 'config') {
-					$a->config[$k] = $rr['v'];
-				} else {
-					$a->config[$family][$k] = $rr['v'];
-				}
-			}
-		}
-	}
+function load_config($family) {
+	return Config::load($family);
 }
 
 /**
- * get a particular config variable given the family name
- * and key. Returns false if not set.
+ * @brief (Deprecated) Get a particular user's config variable given the category name
+ * ($family) and a key.
+ *
+ * Note: This function is deprecated. Use Config::get() instead.
  *
- * If a key is found in the DB but doesn't exist in
- * local config cache, pull it into the cache so we don't have
- *to hit the DB again for this item.
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to query
+ * @param boolean $refresh
+ *  If true the config is loaded from the db and not from the cache
+ * @return mixed Stored value or false if it does not exist
  */
-if(! function_exists('get_config')) {
-	function get_config($family, $key) {
-
-		global $a;
-
-
-		if(isset($a->config[$family][$key])) {
-			if($a->config[$family][$key] === '!<unset>!') {
-				return false;
-			}
-			return $a->config[$family][$key];
-		}
-		$ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
-				dbesc($family),
-				dbesc($key)
-		);
-		if(count($ret)) {
-			// manage array value
-			$val = (preg_match("|^a:[0-9]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
-			$a->config[$family][$key] = $val;
-			return $val;
-		}
-		else {
-			$a->config[$family][$key] = '!<unset>!';
-		}
-		return false;
-	}
+function get_config($family, $key, $refresh = false) {
+	$v = Config::get($family, $key, false, $refresh);
+	return $v;
 }
 
 /**
- * Store a config value ($value) in the category ($family)
- * under the key ($key)
- * 
- * Return the value, or false if the database update failed
+ * @brief (Deprecated) Sets a configuration value for system config
+ *
+ * Note: This function is deprecated. Use Config::set() instead.
+ *
+ * @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 if the database update failed
  */
-if(! function_exists('set_config')) {
-
 function set_config($family,$key,$value) {
-	global $a;
-	
-	// manage array value
-	$dbvalue = (is_array($value)?serialize($value):$value);
-	$dbvalue = (is_bool($value) ? intval($value) : $value);
-
-		$a->config[$family][$key] = $value;
-		$ret = q("REPLACE INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
-				dbesc($family),
-				dbesc($key),
-				dbesc($dbvalue)
-		);
-		if($ret) {
-			return $value;
-		}
-		return $ret;
-
-	}
+	return Config::set($family, $key, $value);
 }
 
-
-if(! function_exists('load_pconfig')) {
-	function load_pconfig($uid,$family) {
-		global $a;
-		$r = q("SELECT * FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
-				dbesc($family),
-				intval($uid)
-		);
-		if(count($r)) {
-			foreach($r as $rr) {
-				$k = $rr['k'];
-				$a->config[$uid][$family][$k] = $rr['v'];
-			}
-		}
-	}
+/**
+ * @brief (Deprecated) Deletes the given key from the system configuration.
+ *
+ * Note: This function is deprecated. Use Config::delete() instead.
+ *
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to delete
+ * @return mixed
+ */
+function del_config($family,$key) {
+	return Config::delete($family, $key);
 }
 
-
-/**
- * get a particular user-specific config variable given the family name, 
- * the user id and key. Returns false if not set.
- *
- * If a key is found in the DB but doesn't exist in
- * local config cache, pull it into the cache so we don't have
- * to hit the DB again for this item.
+/**
+ * @brief (Deprecated) Loads all configuration values of a user's config family into a cached storage.
+ *
+ * Note: This function is deprecated. Use PConfig::load() instead.
+ *
+ * @param string $uid
+ *  The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @return void
  */
-if(! function_exists('get_pconfig')) {
-	function get_pconfig($uid,$family, $key) {
-
-		global $a;
-
-
-		if(isset($a->config[$uid][$family][$key])) {
-			if($a->config[$uid][$family][$key] === '!<unset>!') {
-				return false;
-			}
-			return $a->config[$uid][$family][$key];
-		}
-
-
-		$ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
-				intval($uid),
-				dbesc($family),
-				dbesc($key)
-		);
-
-		if(count($ret)) {
-			$val = (preg_match("|^a:[0-9]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
-			$a->config[$uid][$family][$key] = $val;
-			return $val;
-		}
-		else {
-			$a->config[$uid][$family][$key] = '!<unset>!';
-		}
-		return false;
-	}
+function load_pconfig($uid,$family) {
+	return PConfig::load($uid, $family);
 }
 
 /**
- * Delete a value from config. This function 
- * deletes both: db value and cache entry. 
+ * @brief (Deprecated) Get a particular user's config variable given the category name
+ * ($family) and a key.
+ *
+ * Note: This function is deprecated. Use PConfig::get() instead.
+ *
+ * @param string $uid
+ *  The user_id
+ * @param string $family
+ *  The category of the configuration value
+ * @param string $key
+ *  The configuration key to query
+ * @param boolean $refresh
+ *  If true the config is loaded from the db and not from the cache
+ * @return mixed Stored value or false if it does not exist
  */
-if(! function_exists('del_config')) {
-	function del_config($family,$key) {
-
-		global $a;
-		if(x($a->config[$family],$key))
-			unset($a->config[$family][$key]);
-		$ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
-				dbesc($family),
-				dbesc($key)
-		);
-		return $ret;
-	}
+function get_pconfig($uid, $family, $key, $refresh = false) {
+	$v = PConfig::get($uid, $family, $key, false, $refresh);
+	return $v;
 }
 
-
-/**
- * Store a user-specific config value ($value) for user $uid in the category ($family)
- * under the key ($key). 
- * 
- * Return the value, or false if the database update failed
+/**
+ * @brief (Deprecated) Sets a configuration value for a user
+ *
+ * Note: This function is deprecated. Use PConfig::set() instead.
+ *
+ * @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
  */
-if(! function_exists('set_pconfig')) {
-	function set_pconfig($uid,$family,$key,$value) {
-
-		global $a;
-
-		// manage array value
-		$dbvalue = (is_array($value)?serialize($value):$value);
-		$dbvalue = (is_bool($value)?serialize($value):$value);
-
-
-		$a->config[$uid][$family][$key] = $value;
-		$ret = q("REPLACE INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
-				intval($uid),
-				dbesc($family),
-				dbesc($key),
-				dbesc($dbvalue)
-		);
-		if($ret) {
-			return $value;
-		}
-		return $ret;
-
-	}
+function set_pconfig($uid,$family,$key,$value) {
+	return PConfig::set($uid, $family, $key, $value);
 }
 
-if(! function_exists('del_pconfig')) {
-	function del_pconfig($uid,$family,$key) {
-
-		global $a;
-		if(x($a->config[$uid][$family],$key))
-			unset($a->config[$uid][$family][$key]);
-		$ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
-				intval($uid),
-				dbesc($family),
-				dbesc($key)
-		);
-		return $ret;
-	}
+/**
+ * @brief (Deprecated) Deletes the given key from the users's configuration.
+ *
+ * Note: This function is deprecated. Use PConfig::delete() instead.
+ *
+ * @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
+ */
+function del_pconfig($uid,$family,$key) {
+	return PConfig::delete($uid, $family, $key);
 }