1
0
Fork 0

Fix PHPDoc comments project-wide

This commit is contained in:
Hypolite Petovan 2019-01-06 16:06:53 -05:00
commit 3282ce5389
113 changed files with 1703 additions and 795 deletions

View file

@ -21,7 +21,7 @@ use Friendica\BaseObject;
class PConfig extends BaseObject
{
/**
* @var Friendica\Core\Config\IPConfigAdapter
* @var \Friendica\Core\Config\IPConfigAdapter
*/
private static $adapter = null;
@ -51,6 +51,7 @@ class PConfig extends BaseObject
* @param string $family The category of the configuration value
*
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function load($uid, $family)
{
@ -80,6 +81,7 @@ class PConfig extends BaseObject
* @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
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function get($uid, $family, $key, $default_value = null, $refresh = false)
{
@ -101,7 +103,7 @@ class PConfig extends BaseObject
* Stores a config value ($value) in the category ($family) under the key ($key)
* for the user_id $uid.
*
* @note Please do not store booleans - convert to 0/1 integer values!
* @note Please do not store booleans - convert to 0/1 integer values!
*
* @param string $uid The user_id
* @param string $family The category of the configuration value
@ -109,6 +111,7 @@ class PConfig extends BaseObject
* @param string $value The value to store
*
* @return bool Operation success
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function set($uid, $family, $key, $value)
{
@ -135,6 +138,7 @@ class PConfig extends BaseObject
* @param string $key The configuration key to delete
*
* @return mixed
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function delete($uid, $family, $key)
{