Adding descriptions

diff --git a/src/Core/Config.php b/src/Core/Config.php
index c8edcb2928694b7b4b49b11108ce52c2acd498bf..0db8f0b882bb318801bed7f9d20cc346d9156902 100644 (file)
--- a/src/Core/Config.php
+++ b/src/Core/Config.php
@@ -8,9 +8,6 @@
  */
 namespace Friendica\Core;
 
-use Friendica\Core\Config\IConfigAdapter;
-use Friendica\Core\Config\IConfigCache;
-
 /**
  * @brief Arbitrary system configuration storage
  *
@@ -21,19 +18,19 @@ use Friendica\Core\Config\IConfigCache;
 class Config
 {
        /**
-        * @var IConfigAdapter
+        * @var Config\IConfigAdapter
         */
        private static $adapter;
 
        /**
-        * @var IConfigCache
+        * @var Config\IConfigCache
         */
        private static $config;
 
        /**
         * Initialize the config with only the cache
         *
-        * @param IConfigCache $config  The configuration cache
+        * @param Config\IConfigCache $config  The configuration cache
         */
        public static function init($config)
        {
@@ -43,7 +40,7 @@ class Config
        /**
         * Add the adapter for DB-backend
         *
-        * @param $adapter
+        * @param Config\IConfigAdapter $adapter
         */
        public static function setAdapter($adapter)
        {

diff --git a/src/Core/Config/ConfigCache.php b/src/Core/Config/ConfigCache.php
index b50ba3e00450eaf40bf8d177d1164960325ac8d3..355b1df2f5c3d3b56d7b67acd7d4222379d13c03 100644 (file)
--- a/src/Core/Config/ConfigCache.php
+++ b/src/Core/Config/ConfigCache.php
@@ -2,6 +2,13 @@
 
 namespace Friendica\Core\Config;
 
+/**
+ * The Friendica config cache for the application
+ * Initial, all *.config.php files are loaded into this cache with the
+ * ConfigCacheLoader ( @see ConfigCacheLoader )
+ *
+ * Is used for further caching operations too (depending on the ConfigAdapter )
+ */
 class ConfigCache implements IConfigCache, IPConfigCache
 {
        /**
@@ -12,12 +19,15 @@ class ConfigCache implements IConfigCache, IPConfigCache
         */
        public $config;
 
-       public function __construct($config = [], $overwrite = false)
+       /**
+        * @param array $config    A initial config array
+        */
+       public function __construct($config = [])
        {
                $this->config = [];
 
                if (isset($config)) {
-                       $this->loadConfigArray($config, $overwrite);
+                       $this->loadConfigArray($config, true);
                }
        }
 

diff --git a/src/Core/Config/ConfigCacheLoader.php b/src/Core/Config/ConfigCacheLoader.php
index 287be7d5228c32debba7b4584705d4d9867713e2..a23e1e848a07259878e8dc5d680dc669206312df 100644 (file)
--- a/src/Core/Config/ConfigCacheLoader.php
+++ b/src/Core/Config/ConfigCacheLoader.php
@@ -2,15 +2,29 @@
 
 namespace Friendica\Core\Config;
 
+/**
+ * The ConfigCacheLoader loads config-files and stores them in a ConfigCache ( @see ConfigCache )
+ *
+ * It is capable of loading the following config files:
+ * - *.config.php   (current)
+ * - *.ini.php      (deprecated)
+ * - *.htconfig.php (deprecated)
+ */
 class ConfigCacheLoader
 {
+       /**
+        * The Sub directory of the config-files
+        * @var string
+        */
+       const SUBDIRECTORY = '/config/';
+
        private $baseDir;
        private $configDir;
 
        public function __construct($baseDir)
        {
                $this->baseDir = $baseDir;
-               $this->configDir = $baseDir . '/config/';
+               $this->configDir = $baseDir . self::SUBDIRECTORY;
        }
 
        /**

diff --git a/src/Core/Config/IConfigCache.php b/src/Core/Config/IConfigCache.php
index 191333c44a8a427e901ecd49a9d70ee99b2b3119..8266cc2dd4399f87a77ef094d265e4a72ab682e2 100644 (file)
--- a/src/Core/Config/IConfigCache.php
+++ b/src/Core/Config/IConfigCache.php
@@ -2,6 +2,9 @@
 
 namespace Friendica\Core\Config;
 
+/**
+ * The interface for a system-wide ConfigCache
+ */
 interface IConfigCache
 {
        /**

diff --git a/src/Core/Config/IPConfigCache.php b/src/Core/Config/IPConfigCache.php
index a17e5a03bec6d7c836b2612dd5844f9c1026b3c1..6a57dafa891764fdabae07e7e890b704fba93654 100644 (file)
--- a/src/Core/Config/IPConfigCache.php
+++ b/src/Core/Config/IPConfigCache.php
@@ -2,6 +2,9 @@
 
 namespace Friendica\Core\Config;
 
+/**
+ * The interface for a user-specific config cache
+ */
 interface IPConfigCache
 {
        /**

diff --git a/src/Core/PConfig.php b/src/Core/PConfig.php
index 1f9f36638d8535f8501249d658bce46844aa23b4..8782a20d234239a048cff2ddfb078276704002e8 100644 (file)
--- a/src/Core/PConfig.php
+++ b/src/Core/PConfig.php
@@ -8,8 +8,6 @@
  */
 namespace Friendica\Core;
 
-use Friendica\Core\Config\IPConfigCache;
-
 /**
  * @brief Management of user configuration storage
  * Note:
@@ -20,19 +18,19 @@ use Friendica\Core\Config\IPConfigCache;
 class PConfig
 {
        /**
-        * @var \Friendica\Core\Config\IPConfigAdapter
+        * @var Config\IPConfigAdapter
         */
        private static $adapter;
 
        /**
-        * @var IPConfigCache
+        * @var Config\IPConfigCache
         */
        private static $config;
 
        /**
         * Initialize the config with only the cache
         *
-        * @param IPConfigCache $config  The configuration cache
+        * @param Config\IPConfigCache $config  The configuration cache
         */
        public static function init($config)
        {
@@ -42,7 +40,7 @@ class PConfig
        /**
         * Add the adapter for DB-backend
         *
-        * @param $adapter
+        * @param Config\IPConfigAdapter $adapter
         */
        public static function setAdapter($adapter)
        {
@@ -59,7 +57,6 @@ class PConfig
         * @param string $family The category of the configuration value
         *
         * @return void
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function load($uid, $family)
        {
@@ -129,7 +126,6 @@ class PConfig
         * @param string $key    The configuration key to delete
         *
         * @return mixed
-        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function delete($uid, $family, $key)
        {