]> git.mxchange.org Git - friendica.git/commitdiff
fix phpdoc
authorPhilipp Holzer <admin+github@philipp.info>
Sun, 14 Jul 2019 20:41:09 +0000 (22:41 +0200)
committerPhilipp Holzer <admin+github@philipp.info>
Sun, 14 Jul 2019 20:41:09 +0000 (22:41 +0200)
src/Core/Config/Cache/ConfigCache.php
src/Core/Config/JitConfiguration.php
src/Core/Config/PreloadConfiguration.php

index 3119b5db123c4d1665c587b907cb6363fd8d0d56..bafb3fc95738d7c58f41a86c3b5063b0219d22fb 100644 (file)
@@ -68,7 +68,7 @@ class ConfigCache
         *
         * @return null|mixed Returns the value of the Config entry or null if not set
         */
-       public function get(string $cat, string $key = null)
+       public function get(string $cat, $key = null)
        {
                if (isset($this->config[$cat][$key])) {
                        return $this->config[$cat][$key];
index e5b7b5e47c9f2a7d2e104f028917ef79cb9cd752..40aa5d6f6c9418c522b3ef51d42510b9a7628902 100644 (file)
@@ -5,10 +5,11 @@ namespace Friendica\Core\Config;
 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 )
+ * This class implements the Just-In-Time configuration, which will cache
+ * config values in a cache, once they are retrieved.
+ *
+ * Default Configuration type.
+ * Provides the best performance for pages loading few configuration variables.
  */
 class JitConfiguration extends Configuration
 {
@@ -106,16 +107,7 @@ class JitConfiguration extends Configuration
        }
 
        /**
-        * @brief Deletes the given key from the system configuration.
-        *
-        * Removes the configured value from the stored cache in $this->configCache
-        * (@param string $cat The category of the configuration value
-        *
-        * @param string $key The configuration key to delete
-        *
-        * @return bool
-        * @see   ConfigCache ) and removes it from the database (@see IConfigAdapter ).
-        *
+        * {@inheritDoc}
         */
        public function delete(string $cat, string $key)
        {
index bf57661a1b28d47c8d4a682ad91756f226cb3cf1..b5823c614473143f3b46363305b82ed1b7a93ac7 100644 (file)
@@ -5,10 +5,10 @@ namespace Friendica\Core\Config;
 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 )
+ * This class implements the preload Time configuration, which will cache
+ * all config values per call in a cache.
+ *
+ * Minimizes the number of database queries to retrieve configuration values at the cost of memory.
  */
 class PreloadConfiguration extends Configuration
 {