2011-08-01 19:51:01 -04:00
|
|
|
<?php
|
2011-08-10 04:19:27 -04:00
|
|
|
/**
|
2016-06-06 04:01:14 -04:00
|
|
|
* @file include/config.php
|
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief (Deprecated) Arbitrary configuration storage
|
2011-08-10 04:19:27 -04:00
|
|
|
* Note:
|
|
|
|
* Please do not store booleans - convert to 0/1 integer values
|
|
|
|
* The get_?config() functions return boolean false for keys that are unset,
|
2012-05-19 18:11:32 -04:00
|
|
|
* and this could lead to subtle bugs.
|
2011-08-10 04:19:27 -04:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2016-06-10 05:52:01 -04:00
|
|
|
use \Friendica\Core\Config;
|
|
|
|
use \Friendica\Core\PConfig;
|
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief (Deprecated) Loads all configuration values of family into a cached storage.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* Note: This function is deprecated. Use Config::load() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @param string $family
|
|
|
|
* The category of the configuration value
|
|
|
|
* @return void
|
|
|
|
*/
|
2011-08-01 19:51:01 -04:00
|
|
|
function load_config($family) {
|
2016-06-08 05:02:18 -04:00
|
|
|
return Config::load($family);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief (Deprecated) Get a particular user's config variable given the category name
|
2016-06-06 04:01:14 -04:00
|
|
|
* ($family) and a key.
|
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* Note: This function is deprecated. Use Config::get() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @param string $family
|
|
|
|
* The category of the configuration value
|
|
|
|
* @param string $key
|
|
|
|
* The configuration key to query
|
2016-06-08 15:52:10 -04:00
|
|
|
* @param boolean $refresh
|
|
|
|
* If true the config is loaded from the db and not from the cache
|
2016-06-06 04:01:14 -04:00
|
|
|
* @return mixed Stored value or false if it does not exist
|
|
|
|
*/
|
2016-06-08 15:52:10 -04:00
|
|
|
function get_config($family, $key, $refresh = false) {
|
2016-06-10 06:00:34 -04:00
|
|
|
$v = Config::get($family, $key, false, $refresh);
|
2016-06-08 15:52:10 -04:00
|
|
|
return $v;
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief (Deprecated) Sets a configuration value for system config
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* Note: This function is deprecated. Use Config::set() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @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
|
|
|
|
*/
|
2011-08-01 19:51:01 -04:00
|
|
|
function set_config($family,$key,$value) {
|
2016-06-08 05:02:18 -04:00
|
|
|
return Config::set($family, $key, $value);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief (Deprecated) Deletes the given key from the system configuration.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* Note: This function is deprecated. Use Config::delete() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @param string $family
|
|
|
|
* The category of the configuration value
|
|
|
|
* @param string $key
|
|
|
|
* The configuration key to delete
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
function del_config($family,$key) {
|
2016-06-08 05:02:18 -04:00
|
|
|
return Config::delete($family, $key);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-06-06 04:22:14 -04:00
|
|
|
* @brief (Deprecated) Loads all configuration values of a user's config family into a cached storage.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-06 04:22:14 -04:00
|
|
|
* Note: This function is deprecated. Use PConfig::load() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @param string $uid
|
|
|
|
* The user_id
|
|
|
|
* @param string $family
|
|
|
|
* The category of the configuration value
|
|
|
|
* @return void
|
|
|
|
*/
|
2011-08-01 19:51:01 -04:00
|
|
|
function load_pconfig($uid,$family) {
|
2016-06-06 04:22:14 -04:00
|
|
|
return PConfig::load($uid, $family);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-06 04:22:14 -04:00
|
|
|
* @brief (Deprecated) Get a particular user's config variable given the category name
|
2016-06-06 04:01:14 -04:00
|
|
|
* ($family) and a key.
|
|
|
|
*
|
2016-06-06 04:22:14 -04:00
|
|
|
* Note: This function is deprecated. Use PConfig::get() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @param string $uid
|
|
|
|
* The user_id
|
|
|
|
* @param string $family
|
|
|
|
* The category of the configuration value
|
|
|
|
* @param string $key
|
|
|
|
* The configuration key to query
|
2016-06-08 15:52:10 -04:00
|
|
|
* @param boolean $refresh
|
|
|
|
* If true the config is loaded from the db and not from the cache
|
2016-06-06 04:01:14 -04:00
|
|
|
* @return mixed Stored value or false if it does not exist
|
|
|
|
*/
|
2016-06-08 15:52:10 -04:00
|
|
|
function get_pconfig($uid, $family, $key, $refresh = false) {
|
2016-06-10 06:00:34 -04:00
|
|
|
$v = PConfig::get($uid, $family, $key, false, $refresh);
|
2016-06-08 15:52:10 -04:00
|
|
|
return $v;
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-06 04:22:14 -04:00
|
|
|
* @brief (Deprecated) Sets a configuration value for a user
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-06 04:22:14 -04:00
|
|
|
* Note: This function is deprecated. Use PConfig::set() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @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
|
|
|
|
*/
|
2011-08-01 19:51:01 -04:00
|
|
|
function set_pconfig($uid,$family,$key,$value) {
|
2016-06-06 04:22:14 -04:00
|
|
|
return PConfig::set($uid, $family, $key, $value);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|
2011-08-01 19:51:01 -04:00
|
|
|
|
2016-06-06 04:01:14 -04:00
|
|
|
/**
|
2016-06-06 04:22:14 -04:00
|
|
|
* @brief (Deprecated) Deletes the given key from the users's configuration.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
2016-06-06 04:46:33 -04:00
|
|
|
* Note: This function is deprecated. Use PConfig::delete() instead.
|
2016-06-06 04:01:14 -04:00
|
|
|
*
|
|
|
|
* @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
|
|
|
|
*/
|
2011-08-01 19:51:01 -04:00
|
|
|
function del_pconfig($uid,$family,$key) {
|
2016-06-06 04:46:33 -04:00
|
|
|
return PConfig::delete($uid, $family, $key);
|
2016-06-06 04:01:14 -04:00
|
|
|
}
|