Refactor IManageConfigValues interface

This commit is contained in:
Philipp 2022-12-28 02:07:38 +01:00
parent 326566638f
commit 1e574d5383
No known key found for this signature in database
GPG key ID: 24A7501396EB5432
13 changed files with 46 additions and 49 deletions

View file

@ -30,36 +30,32 @@ use Friendica\Core\Config\ValueObject\Cache;
interface IManageConfigValues
{
/**
* Loads all configuration values of family into a cached storage.
* Reloads all configuration values (from filesystem and environment variables)
*
* All configuration values of the system are stored in the cache.
*
* @param string $cat The category of the configuration value
*
* @return void
*
* @throws ConfigPersistenceException In case the persistence layer throws errors
*/
public function load(string $cat = 'config');
public function reload();
/**
* Get a particular user's config variable given the category name
* ($cat) and a $key.
*
* Get a particular config value from the given category ($cat)
* and the $key from a cached storage either from the database or from the cache.
*
* @param string $cat The category of the configuration value
* @param string $key The configuration key to query
* @param mixed $default_value Deprecated, use `Config->get($cat, $key, null, $refresh) ?? $default_value` instead
* @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 ConfigPersistenceException In case the persistence layer throws errors
*
*/
public function get(string $cat, string $key, $default_value = null, bool $refresh = false);
public function get(string $cat, string $key, $default_value = null);
/**
* Sets a configuration value for system config
@ -81,6 +77,8 @@ interface IManageConfigValues
/**
* Save back the overridden values of the config cache
*
* @throws ConfigPersistenceException In case the persistence layer throws errors
*/
public function save();

View file

@ -81,21 +81,4 @@ class Config
return $configCache;
}
/**
* @param Cache $configCache The config cache of this adapter
* @param Repository\Config $configRepo The configuration repository
*
* @return Capability\IManageConfigValues
*/
public function create(Util\ConfigFileManager $loader, Cache $configCache, Repository\Config $configRepo)
{
if ($configCache->get('system', 'config_adapter') === 'preload') {
$configuration = new Type\PreloadConfig($loader, $configCache, $configRepo);
} else {
$configuration = new Type\JitConfig($loader, $configCache, $configRepo);
}
return $configuration;
}
}

View file

@ -22,6 +22,8 @@
namespace Friendica\Core\Config\Model;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Config\Exception\ConfigFileException;
use Friendica\Core\Config\Exception\ConfigPersistenceException;
use Friendica\Core\Config\Util\ConfigFileManager;
use Friendica\Core\Config\ValueObject\Cache;
@ -38,14 +40,19 @@ class Config implements IManageConfigValues
/** @var ConfigFileManager */
protected $configFileManager;
/** @var array */
protected $server;
/**
* @param ConfigFileManager $configFileManager The configuration file manager to save back configs
* @param Cache $configCache The configuration cache (based on the config-files)
* @param Cache $configCache The configuration cache (based on the config-files)
* @param array $server The $_SERVER variable
*/
public function __construct(ConfigFileManager $configFileManager, Cache $configCache)
public function __construct(ConfigFileManager $configFileManager, Cache $configCache, array $server = [])
{
$this->configFileManager = $configFileManager;
$this->configCache = $configCache;
$this->server = $server;
}
/**
@ -56,24 +63,36 @@ class Config implements IManageConfigValues
return $this->configCache;
}
/** {@inheritDoc} */
public function save()
{
$this->configFileManager->saveData($this->configCache);
try {
$this->configFileManager->saveData($this->configCache);
} catch (ConfigFileException $e) {
throw new ConfigPersistenceException('Cannot save config', $e);
}
}
public function load(string $cat = 'config')
/** {@inheritDoc} */
public function reload()
{
$configCache = new Cache();
$this->configFileManager->setupCache($configCache, $_SERVER);
try {
$this->configFileManager->setupCache($configCache, $this->server);
} catch (ConfigFileException $e) {
throw new ConfigPersistenceException('Cannot reload config', $e);
}
$this->configCache = $configCache;
}
public function get(string $cat, string $key, $default_value = null, bool $refresh = false)
/** {@inheritDoc} */
public function get(string $cat, string $key, $default_value = null)
{
return $this->configCache->get($cat, $key) ?? $default_value;
}
/** {@inheritDoc} */
public function set(string $cat, string $key, $value, bool $autosave = true): bool
{
$stored = $this->configCache->set($cat, $key, $value, Cache::SOURCE_DATA);
@ -85,6 +104,7 @@ class Config implements IManageConfigValues
return $stored;
}
/** {@inheritDoc} */
public function delete(string $cat, string $key, bool $autosave = true): bool
{
$removed = $this->configCache->delete($cat, $key);