]> git.mxchange.org Git - friendica.git/commitdiff
Fixup phpdoc
authorPhilipp Holzer <admin+github@philipp.info>
Mon, 15 Jul 2019 18:19:52 +0000 (20:19 +0200)
committerPhilipp Holzer <admin+github@philipp.info>
Mon, 15 Jul 2019 18:19:52 +0000 (20:19 +0200)
src/Core/Config/PConfiguration.php

index 0dd3a8d3674b842e4b20feb44b119a93a0965ace..fd4ef2bd3fdf84a3c09d5f24d623928c0fc2b001 100644 (file)
@@ -6,7 +6,7 @@ use Friendica\Model;
 
 /**
  * This class is responsible for the user-specific configuration values in Friendica
- * The values are set through the Config-DB-Table (per Config-DB-adapter @see Adapter\IPConfigAdapter )
+ * The values are set through the Config-DB-Table (per Config-DB-model @see Model\Config\PConfig)
  *
  * The configuration cache (@see Cache\PConfigCache ) is used for temporary caching of database calls. This will
  * increase the performance.
@@ -63,16 +63,15 @@ abstract class PConfiguration
         *
         * Get a particular user's config value from the given category ($cat)
         * and the $key with the $uid from a cached storage either from the $this->configAdapter
-        * (@param int $uid The user_id
+        * (@see IConfigAdapter ) or from the $this->configCache (@see PConfigCache ).
         *
+        * @param int     $uid           The user_id
         * @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
-        * @see IConfigAdapter ) or from the $this->configCache (@see PConfigCache ).
-        *
         */
        abstract public function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false);
 
@@ -97,15 +96,14 @@ abstract class PConfiguration
         * Deletes the given key from the users's configuration.
         *
         * Removes the configured value from the stored cache in $this->configCache
-        * (@param int $uid The user_id
+        * (@see ConfigCache ) and removes it from the database (@see IConfigAdapter )
+        *  with the given $uid.
         *
+        * @param int $uid The user_id
         * @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 )
-        *      with the given $uid.
-        *
         */
        abstract public function delete(int $uid, string $cat, string $key);
 }