]> git.mxchange.org Git - friendica.git/commitdiff
codeblock updates
authorPhilipp Holzer <admin@philipp.info>
Tue, 5 Feb 2019 22:42:49 +0000 (23:42 +0100)
committerPhilipp Holzer <admin@philipp.info>
Tue, 5 Feb 2019 22:42:49 +0000 (23:42 +0100)
src/Core/Config/IConfigAdapter.php
src/Core/Config/IPConfigAdapter.php
src/Core/Config/JITConfigAdapter.php
src/Core/Config/JITPConfigAdapter.php
src/Core/Config/PreloadConfigAdapter.php
src/Core/Config/PreloadPConfigAdapter.php

index 5bbb61ae80119ff5d9e02cbe3b2b5f78fe1dc90b..139483de26922d9db7761e2a413d7a6218af098a 100644 (file)
@@ -9,10 +9,7 @@ namespace Friendica\Core\Config;
 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 Config::$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 static::$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,8 +31,6 @@ 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.
         *
@@ -58,9 +45,7 @@ interface IConfigAdapter
        public function set($cat, $k, $value);
 
        /**
-        * @brief Deletes the given key from the system configuration.
-        *
-        * Removes the configured value from the stored cache in Config::$config
+        * Removes the configured value from the stored cache
         * and removes it from the database.
         *
         * @param string $cat The category of the configuration value
index f4ad392d7f3585b1c6f0f5853f397b9c76f8ea36..e62fc9c93fb83e0a427fcc638d05839229fb2c35 100644 (file)
@@ -15,10 +15,7 @@ namespace Friendica\Core\Config;
 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 self::$config[$uid].
+        * Loads all configuration values of a user's config family into a cached storage.
         *
         * @param string $uid The user_id
         * @param string $cat The category of the configuration value
@@ -28,12 +25,9 @@ interface IPConfigAdapter
        public function load($uid, $cat);
 
        /**
-        * @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 user's config value from the given category ($family)
-        * and the $key from a cached storage in self::$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
@@ -45,8 +39,6 @@ interface IPConfigAdapter
        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.
         *
@@ -62,9 +54,7 @@ interface IPConfigAdapter
        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 self::$config[$uid]
+        * Removes the configured value from the stored cache
         * and removes it from the database.
         *
         * @param string $uid The user_id
index 5e7e786f07758cabe82089ec47500e7fad2f249f..e7aecb933b673af56a7a65e9f3cdccf28f596d37 100644 (file)
@@ -28,6 +28,9 @@ class JITConfigAdapter implements IConfigAdapter
                $this->configCache = $configCache;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function load($cat = "config")
        {
                // We don't preload "system" anymore.
@@ -50,6 +53,9 @@ class JITConfigAdapter implements IConfigAdapter
                DBA::close($configs);
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function get($cat, $k, $default_value = null, $refresh = false)
        {
                if (!$refresh) {
@@ -92,6 +98,9 @@ class JITConfigAdapter implements IConfigAdapter
                return $default_value;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function set($cat, $k, $value)
        {
                // We store our setting values in a string variable.
@@ -129,6 +138,9 @@ class JITConfigAdapter implements IConfigAdapter
                return $result;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function delete($cat, $k)
        {
                if (isset($this->cache[$cat][$k])) {
index 2fd77059283da20db0161134af2cf072e6820fd5..b1a15601cc4cdaa28efbd7687c7c0aeb65e65097 100644 (file)
@@ -28,6 +28,9 @@ class JITPConfigAdapter implements IPConfigAdapter
                $this->configCache = $configCache;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function load($uid, $cat)
        {
                $pconfigs = DBA::select('pconfig', ['v', 'k'], ['cat' => $cat, 'uid' => $uid]);
@@ -46,6 +49,9 @@ class JITPConfigAdapter implements IPConfigAdapter
                DBA::close($pconfigs);
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function get($uid, $cat, $k, $default_value = null, $refresh = false)
        {
                if (!$refresh) {
@@ -82,6 +88,9 @@ class JITPConfigAdapter implements IPConfigAdapter
                }
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function set($uid, $cat, $k, $value)
        {
                // We store our setting values in a string variable.
@@ -109,6 +118,9 @@ class JITPConfigAdapter implements IPConfigAdapter
                return $result;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function delete($uid, $cat, $k)
        {
                $this->configCache->deleteP($uid, $cat, $k);
index bda9b28aae58330eee116639ada867c5a5a99c72..d5fbd982bf56e6f912fa5568c3168087819fdf61 100644 (file)
@@ -30,6 +30,9 @@ class PreloadConfigAdapter implements IConfigAdapter
                $this->load();
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function load($family = 'config')
        {
                if ($this->config_loaded) {
@@ -45,6 +48,9 @@ class PreloadConfigAdapter implements IConfigAdapter
                $this->config_loaded = true;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function get($cat, $k, $default_value = null, $refresh = false)
        {
                if ($refresh) {
@@ -59,6 +65,9 @@ class PreloadConfigAdapter implements IConfigAdapter
                return $return;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function set($cat, $k, $value)
        {
                // We store our setting values as strings.
@@ -83,6 +92,9 @@ class PreloadConfigAdapter implements IConfigAdapter
                return true;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function delete($cat, $k)
        {
                $this->configCache->delete($cat, $k);
index b49f39382f175c5926606abf9d882c3e171acfc5..af97815adef38d159ab6ba44f27766d10ed7ca9d 100644 (file)
@@ -34,6 +34,9 @@ class PreloadPConfigAdapter implements IPConfigAdapter
                }
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function load($uid, $family)
        {
                if ($this->config_loaded) {
@@ -53,6 +56,9 @@ class PreloadPConfigAdapter implements IPConfigAdapter
                $this->config_loaded = true;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function get($uid, $cat, $k, $default_value = null, $refresh = false)
        {
                if (!$this->config_loaded) {
@@ -71,6 +77,9 @@ class PreloadPConfigAdapter implements IPConfigAdapter
                return $this->configCache->getP($uid, $cat, $k, $default_value);;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function set($uid, $cat, $k, $value)
        {
                if (!$this->config_loaded) {
@@ -98,6 +107,9 @@ class PreloadPConfigAdapter implements IPConfigAdapter
                return true;
        }
 
+       /**
+        * {@inheritdoc}
+        */
        public function delete($uid, $cat, $k)
        {
                if (!$this->config_loaded) {