friendica
/
friendica
mirror of https://github.com/friendica/friendica
6
0
Fork 1
Code Issues Packages Projects Releases 1 Wiki Activity

Fixup phpdoc

This commit is contained in:
Philipp Holzer 2019-07-15 20:19:52 +02:00
parent 9d98a4ce3a
commit 74f7c16585
No known key found for this signature in database
GPG Key ID: D8365C3D36B77D90
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/Core/Config/PConfiguration.php
View File

@ -6,7 +6,7 @@ use Friendica\Model;
/** /**
* This class is responsible for the user-specific configuration values in Friendica * 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 * The configuration cache (@see Cache\PConfigCache ) is used for temporary caching of database calls. This will
* increase the performance. * increase the performance.
@ -63,16 +63,15 @@ abstract class PConfiguration
* *
* Get a particular user's config value from the given category ($cat) * 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 * 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 $cat The category of the configuration value
* @param string $key The configuration key to query * @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 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) * @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 * @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); 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. * Deletes the given key from the users's configuration.
* *
* Removes the configured value from the stored cache in $this->configCache * 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 $cat The category of the configuration value
* @param string $key The configuration key to delete * @param string $key The configuration key to delete
* *
* @return bool * @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); abstract public function delete(int $uid, string $cat, string $key);
} }