codeblock updates

This commit is contained in:
Philipp Holzer 2019-02-05 23:42:49 +01:00
parent d9e38be4df
commit 62c79e1c4f
No known key found for this signature in database
GPG key ID: 517BE60E2CE5C8A5
6 changed files with 54 additions and 31 deletions

View file

@ -15,10 +15,7 @@ namespace Friendica\Core\Config;
interface IPConfigAdapter
{
/**
* @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 self::$config[$uid].
* Loads all configuration values of a user's config family into a cached storage.
*
* @param string $uid The user_id
* @param string $cat The category of the configuration value
@ -28,12 +25,9 @@ interface IPConfigAdapter
public function load($uid, $cat);
/**
* @brief Get a particular user's config variable given the category name
* 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 self::$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
@ -45,8 +39,6 @@ interface IPConfigAdapter
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.
*
@ -62,9 +54,7 @@ interface IPConfigAdapter
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 self::$config[$uid]
* Removes the configured value from the stored cache
* and removes it from the database.
*
* @param string $uid The user_id