-<?php\r
-\r
-/*\r
- * To change this license header, choose License Headers in Project Properties.\r
- * To change this template file, choose Tools | Templates\r
- * and open the template in the editor.\r
- */\r
-\r
-namespace Friendica\Core\Config;\r
-\r
-/**\r
- *\r
- * @author benlo\r
- */\r
-interface IPConfigAdapter\r
-{\r
- /**\r
- * @brief Loads all configuration values of a user's config family into a cached storage.\r
- *\r
- * All configuration values of the given user are stored in global cache\r
- * which is available under the global variable $a->config[$uid].\r
- *\r
- * @param string $uid The user_id\r
- * @param string $cat The category of the configuration value\r
- *\r
- * @return void\r
- */\r
- public function load($uid, $cat);\r
-\r
- /**\r
- * @brief Get a particular user's config variable given the category name\r
- * ($family) and a key.\r
- *\r
- * Get a particular user's config value from the given category ($family)\r
- * and the $key from a cached storage in $a->config[$uid].\r
- *\r
- * @param string $uid The user_id\r
- * @param string $cat The category of the configuration value\r
- * @param string $k The configuration key to query\r
- * @param mixed $default_value optional, The value to return if key is not set (default: null)\r
- * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false)\r
- *\r
- * @return mixed Stored value or null if it does not exist\r
- */\r
- public function get($uid, $cat, $k, $default_value = null, $refresh = false);\r
-\r
- /**\r
- * @brief Sets a configuration value for a user\r
- *\r
- * Stores a config value ($value) in the category ($family) under the key ($key)\r
- * for the user_id $uid.\r
- *\r
- * @note Please do not store booleans - convert to 0/1 integer values!\r
- *\r
- * @param string $uid The user_id\r
- * @param string $cat The category of the configuration value\r
- * @param string $k The configuration key to set\r
- * @param string $value The value to store\r
- *\r
- * @return mixed Stored $value or false\r
- */\r
- public function set($uid, $cat, $k, $value);\r
-\r
- /**\r
- * @brief Deletes the given key from the users's configuration.\r
- *\r
- * Removes the configured value from the stored cache in $a->config[$uid]\r
- * and removes it from the database.\r
- *\r
- * @param string $uid The user_id\r
- * @param string $cat The category of the configuration value\r
- * @param string $k The configuration key to delete\r
- *\r
- * @return mixed\r
- */\r
- public function delete($uid, $cat, $k);\r
-}\r
+<?php
+
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+
+namespace Friendica\Core\Config;
+
+/**
+ *
+ * @author benlo
+ */
+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 $a->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);
+}
projects / friendica.git / blobdiff