]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Config/IConfigAdapter.php
bugfixing ini-loading
[friendica.git] / src / Core / Config / IConfigAdapter.php
index d1bb60033166fb97322cfcfb27bf28be985e6c33..139483de26922d9db7761e2a413d7a6218af098a 100644 (file)
@@ -4,15 +4,12 @@ namespace Friendica\Core\Config;
 
 /**
  *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
+ * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
 interface IConfigAdapter
 {
        /**
-        * @brief Loads all configuration values into a cached storage.
-        *
-        * All configuration values of the system are stored in global cache
-        * which is available under the global variable $a->config
+        * Loads all configuration values into a cached storage.
         *
         * @param string  $cat The category of the configuration values to load
         *
@@ -21,17 +18,9 @@ interface IConfigAdapter
        public function load($cat = "config");
 
        /**
-        * @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 config value from the given category ($family)
-        * and the $key from a cached storage in $a->config[$uid].
-        * $instore is only used by the set_config function
-        * to determine if the key already exists in the DB
-        * If a key is found in the DB but doesn't exist in
-        * local config cache, pull it into the cache so we don't have
-        * to hit the DB again for this item.
-        *
         * @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)
@@ -42,25 +31,21 @@ interface IConfigAdapter
        public function get($cat, $k, $default_value = null, $refresh = false);
 
        /**
-        * @brief Sets a configuration value for system config
-        *
         * 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 $family The category of the configuration value
-        * @param string $key    The configuration key to set
-        * @param mixed  $value  The value to store
+        * @param string $cat   The category of the configuration value
+        * @param string $k     The configuration key to set
+        * @param mixed  $value The value to store
         *
-        * @return mixed Stored $value or false if the database update failed
+        * @return bool Operation success
         */
        public function set($cat, $k, $value);
 
        /**
-        * @brief Deletes the given key from the system configuration.
-        *
-        * Removes the configured value from the stored cache in $a->config
+        * Removes the configured value from the stored cache
         * and removes it from the database.
         *
         * @param string $cat The category of the configuration value