Removed implicit ::getApp() instance and added docblock

This commit is contained in:
Philipp Holzer 2019-02-05 21:54:55 +01:00
parent 0d096cf32e
commit 800dbc7f44
No known key found for this signature in database
GPG key ID: 517BE60E2CE5C8A5
3 changed files with 18 additions and 24 deletions

View file

@ -6,9 +6,7 @@ namespace Friendica;
require_once 'boot.php';
use Friendica\Core\Config;
use Friendica\Factory;
use Friendica\Util\BasePath;
use Friendica\Network\HTTPException\InternalServerErrorException;
/**
* Basic object
@ -30,11 +28,7 @@ class BaseObject
public static function getApp()
{
if (empty(self::$app)) {
$basedir = BasePath::create(dirname(__DIR__));
$configLoader = new Config\ConfigCacheLoader($basedir);
$config = Factory\ConfigFactory::createCache($configLoader);
$logger = Factory\LoggerFactory::create('app', $config);
self::$app = new App($config, $logger);
throw new InternalServerErrorException('App isn\' initialized.');
}
return self::$app;

View file

@ -8,6 +8,10 @@
*/
namespace Friendica\Core;
use Friendica\Core\Config\ConfigCache;
use Friendica\Core\Config\IConfigAdapter;
use Friendica\Core\Config\IConfigCache;
/**
* @brief Arbitrary system configuration storage
*
@ -50,8 +54,7 @@ class Config
/**
* @brief Loads all configuration values of family into a cached storage.
*
* All configuration values of the system are stored in global cache
* which is available under the global variable self::$config
* All configuration values of the system are stored in the cache ( @see IConfigCache )
*
* @param string $family The category of the configuration value
*
@ -71,12 +74,8 @@ class Config
* ($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.
* and the $key from a cached storage either from the self::$adapter
* (@see IConfigAdapter ) or from the static::$cache (@see IConfigCache ).
*
* @param string $family The category of the configuration value
* @param string $key The configuration key to query
@ -98,7 +97,6 @@ class Config
* @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.
*
* Note: Please do not store booleans - convert to 0/1 integer values!
*
@ -121,8 +119,8 @@ class Config
/**
* @brief Deletes the given key from the system configuration.
*
* Removes the configured value from the stored cache in Config::$config
* and removes it from the database.
* Removes the configured value from the stored cache in self::$config
* (@see ConfigCache ) and removes it from the database (@see IConfigAdapter ).
*
* @param string $family The category of the configuration value
* @param string $key The configuration key to delete

View file

@ -50,8 +50,8 @@ class PConfig
/**
* @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].
* All configuration values of the given user are stored with the $uid in
* the cache ( @see IPConfigCache )
*
* @param string $uid The user_id
* @param string $family The category of the configuration value
@ -72,7 +72,8 @@ class PConfig
* ($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].
* and the $key with the $uid from a cached storage either from the self::$adapter
* (@see IConfigAdapter ) or from the static::$cache (@see IConfigCache ).
*
* @param string $uid The user_id
* @param string $family The category of the configuration value
@ -118,8 +119,9 @@ class PConfig
/**
* @brief Deletes the given key from the users's configuration.
*
* Removes the configured value from the stored cache in self::$config[$uid]
* and removes it from the database.
* Removes the configured value from the stored cache in self::$config
* (@see ConfigCache ) and removes it from the database (@see IConfigAdapter )
* with the given $uid.
*
* @param string $uid The user_id
* @param string $family The category of the configuration value