Merge remote-tracking branch 'upstream/develop' into ap-delivery-failure

[friendica.git] / src / Core / Config / Adapter / IConfigAdapter.php

diff --git a/src/Core/Config/Adapter/IConfigAdapter.php b/src/Core/Config/Adapter/IConfigAdapter.php
index 8223d33672a2bdd72ac1e491d674135e61826aad..892c476e7c30f3b1d003c0096594b35ffc5b30e7 100644 (file)
--- a/src/Core/Config/Adapter/IConfigAdapter.php
+++ b/src/Core/Config/Adapter/IConfigAdapter.php
@@ -9,7 +9,7 @@ namespace Friendica\Core\Config\Adapter;
 interface IConfigAdapter
 {
        /**
-        * Loads all configuration values into a cached storage.
+        * Loads all configuration values and returns the loaded category as an array.
         *
         * @param string  $cat The category of the configuration values to load
         *
@@ -18,13 +18,15 @@ interface IConfigAdapter
        public function load($cat = "config");
 
        /**
-        * Get a particular user's config variable given the category name
+        * Get a particular system-wide config variable given the category name
         * ($family) and a key.
         *
+        * Note: Boolean variables are defined as 0/1 in the database
+        *
         * @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($cat, $key);
 
@@ -46,9 +48,9 @@ interface IConfigAdapter
         * and removes it from the database.
         *
         * @param string $cat The category of the configuration value
-        * @param string $key   The configuration key to delete
+        * @param string $key The configuration key to delete
         *
-        * @return mixed
+        * @return bool Operation success
         */
        public function delete($cat, $key);
 
@@ -60,7 +62,7 @@ interface IConfigAdapter
        public function isConnected();
 
        /**
-        * Checks, if a config value ($value) in the category ($cat) is already loaded.
+        * Checks, if a config key ($key) in the category ($cat) is already loaded.
         *
         * @param string $cat The configuration category
         * @param string $key The configuration key