4 * To change this license header, choose License Headers in Project Properties.
5 * To change this template file, choose Tools | Templates
6 * and open the template in the editor.
9 namespace Friendica\Core\Config\Adapter;
15 interface IPConfigAdapter
18 * Loads all configuration values of a user's config family and returns the loaded category as an array.
20 * @param string $uid The user_id
21 * @param string $cat The category of the configuration value
25 public function load($uid, $cat);
28 * Get a particular user's config variable given the category name
29 * ($family) and a key.
31 * @param string $uid The user_id
32 * @param string $cat The category of the configuration value
33 * @param string $key The configuration key to query
35 * @return mixed Stored value or "!<unset>!" if it does not exist
37 public function get($uid, $cat, $key);
40 * Stores a config value ($value) in the category ($family) under the key ($key)
41 * for the user_id $uid.
43 * @note Please do not store booleans - convert to 0/1 integer values!
45 * @param string $uid The user_id
46 * @param string $cat The category of the configuration value
47 * @param string $key The configuration key to set
48 * @param string $value The value to store
50 * @return bool Operation success
52 public function set($uid, $cat, $key, $value);
55 * Removes the configured value from the stored cache
56 * and removes it from the database.
58 * @param string $uid The user_id
59 * @param string $cat The category of the configuration value
60 * @param string $key The configuration key to delete
64 public function delete($uid, $cat, $key);
67 * Checks, if the current adapter is connected to the backend
71 public function isConnected();
74 * Checks, if a config key ($key) in the category ($cat) is already loaded for the user_id $uid.
76 * @param string $uid The user_id
77 * @param string $cat The configuration category
78 * @param string $key The configuration key
82 public function isLoaded($uid, $cat, $key);