interface IPConfigAdapter
{
/**
- * Loads all configuration values of a user's config family into a cached storage.
+ * Loads all configuration values of a user's config family and returns the loaded category as an array.
*
* @param string $uid The user_id
* @param string $cat The category of the configuration value
* Get a particular user's config variable given the category name
* ($family) and a key.
*
+ * Note: Boolean variables are defined as 0/1 in the database
+ *
* @param string $uid The user_id
* @param string $cat The category of the configuration value
* @param string $key The configuration key to query
*
- * @return mixed Stored value or "!<unset>!" if it does not exist
+ * @return null|mixed Stored value or null if it does not exist
*/
public function get($uid, $cat, $key);
* @param string $cat The category of the configuration value
* @param string $key The configuration key to delete
*
- * @return bool
+ * @return bool Operation success
*/
public function delete($uid, $cat, $key);
public function isConnected();
/**
- * Checks, if a config value ($value) in the category ($cat) is already loaded for the user_id $uid.
+ * Checks, if a config key ($key) in the category ($cat) is already loaded for the user_id $uid.
*
* @param string $uid The user_id
* @param string $cat The configuration category