X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FConfig%2FIPConfigAdapter.php;h=b912418432e1eb86d15005a4da20911b3cd84bbd;hb=0f7c7cebeb689e9a16d2590eb3c0a715fda45e2b;hp=f78654d39c300f345281351992cec1929b5b7a51;hpb=9665f4ed415d34cbcf09df8c6ca04882303e9544;p=friendica.git diff --git a/src/Core/Config/IPConfigAdapter.php b/src/Core/Config/IPConfigAdapter.php index f78654d39c..b912418432 100644 --- a/src/Core/Config/IPConfigAdapter.php +++ b/src/Core/Config/IPConfigAdapter.php @@ -1,77 +1,77 @@ -config[$uid]. - * - * @param string $uid The user_id - * @param string $cat The category of the configuration value - * - * @return void - */ - public function load($uid, $cat); - - /** - * @brief Get a particular user's config variable given the category name - * ($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]. - * - * @param string $uid The user_id - * @param string $cat The category of the configuration value - * @param string $k 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 function get($uid, $cat, $k, $default_value = null, $refresh = false); - - /** - * @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! - * - * @param string $uid The user_id - * @param string $cat The category of the configuration value - * @param string $k The configuration key to set - * @param string $value The value to store - * - * @return mixed Stored $value or false - */ - public function set($uid, $cat, $k, $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 $cat The category of the configuration value - * @param string $k The configuration key to delete - * - * @return mixed - */ - public function delete($uid, $cat, $k); -} +config[$uid]. + * + * @param string $uid The user_id + * @param string $cat The category of the configuration value + * + * @return void + */ + public function load($uid, $cat); + + /** + * @brief Get a particular user's config variable given the category name + * ($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]. + * + * @param string $uid The user_id + * @param string $cat The category of the configuration value + * @param string $k 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 function get($uid, $cat, $k, $default_value = null, $refresh = false); + + /** + * @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! + * + * @param string $uid The user_id + * @param string $cat The category of the configuration value + * @param string $k The configuration key to set + * @param string $value The value to store + * + * @return bool Operation success + */ + public function set($uid, $cat, $k, $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 $cat The category of the configuration value + * @param string $k The configuration key to delete + * + * @return mixed + */ + public function delete($uid, $cat, $k); +}