X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FConfig%2FConfiguration.php;h=c54fbb27e76a12466621bc7bd2155be1ba80c276;hb=5dcf6bfc58dd69d8535ccc8163ae32e3acfae386;hp=9654fb287f8cc156c0361f396b7006b972f15fe0;hpb=486f1393429afc17ba57f31690fa2388f8925f82;p=friendica.git

diff --git a/src/Core/Config/Configuration.php b/src/Core/Config/Configuration.php
index 9654fb287f..c54fbb27e7 100644
--- a/src/Core/Config/Configuration.php
+++ b/src/Core/Config/Configuration.php
@@ -7,8 +7,8 @@ use Friendica\Model;
 /**
  * This class is responsible for all system-wide configuration values in Friendica
  * There are two types of storage
- * - The Config-Files    (loaded into the FileCache @see Cache\ConfigCache )
- * - The Config-DB-Table (per Config-DB-model @see Model\Config\Config )
+ * - The Config-Files    (loaded into the FileCache @see Cache\ConfigCache)
+ * - The Config-DB-Table (per Config-DB-model @see Model\Config\Config)
  */
 abstract class Configuration
 {
@@ -33,15 +33,68 @@ abstract class Configuration
 	}
 
 	/**
-	 * {@inheritDoc}
+	 * Returns the Config Cache
+	 *
+	 * @return Cache\ConfigCache
 	 */
 	public function getCache()
 	{
 		return $this->configCache;
 	}
 
+	/**
+	 * @brief Loads all configuration values of family into a cached storage.
+	 *
+	 * All configuration values of the system are stored in the cache ( @see ConfigCache )
+	 *
+	 * @param string $cat The category of the configuration value
+	 *
+	 * @return void
+	 */
 	abstract public function load(string $cat = 'config');
+
+	/**
+	 * @brief Get a particular user's config variable given the category name
+	 * ($cat) and a $key.
+	 *
+	 * Get a particular config value from the given category ($cat)
+	 * and the $key from a cached storage either from the $this->configAdapter
+	 * (@see IConfigAdapter) or from the $this->configCache (@see ConfigCache).
+	 *
+	 * @param string  $cat        The category of the configuration value
+	 * @param string  $key           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
+	 */
 	abstract public function get(string $cat, string $key, $default_value = null, bool $refresh = false);
+
+	/**
+	 * @brief Sets a configuration value for system config
+	 *
+	 * Stores a config value ($value) in the category ($cat) under the key ($key)
+	 *
+	 * Note: Please do not store booleans - convert to 0/1 integer values!
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key    The configuration key to set
+	 * @param mixed  $value  The value to store
+	 *
+	 * @return bool Operation success
+	 */
 	abstract public function set(string $cat, string $key, $value);
+
+	/**
+	 * @brief Deletes the given key from the system configuration.
+	 *
+	 * Removes the configured value from the stored cache in $this->configCache
+	 * (@see ConfigCache) and removes it from the database (@see IConfigAdapter).
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key    The configuration key to delete
+	 *
+	 * @return bool
+	 */
 	abstract public function delete(string $cat, string $key);
 }