friendica-github/src/Core/Config.php

156 lines
4.4 KiB
PHP
Raw Normal View History

<?php
/**
* System Configuration Class
*
* @file include/Core/Config.php
*
* @brief Contains the class with methods for system configuration
*/
namespace Friendica\Core;
use Friendica\App;
2018-03-03 17:10:55 +00:00
use Friendica\BaseObject;
/**
2018-03-03 17:10:55 +00:00
* @brief Arbitrary system configuration storage
2017-11-26 11:43:02 +00:00
*
* Note:
2017-11-26 11:43:02 +00:00
* If we ever would decide to return exactly the variable type as entered,
* we will have fun with the additional features. :-)
*/
2018-03-03 17:10:55 +00:00
class Config extends BaseObject
{
2018-03-03 17:10:55 +00:00
/**
2019-01-06 21:06:53 +00:00
* @var \Friendica\Core\Config\IConfigAdapter
2018-03-03 17:10:55 +00:00
*/
private static $adapter = null;
public static function init()
{
// Database isn't ready or populated yet
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
return;
}
2018-03-07 01:04:04 +00:00
if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
2018-03-03 17:10:55 +00:00
self::$adapter = new Config\PreloadConfigAdapter();
} else {
self::$adapter = new Config\JITConfigAdapter();
}
}
/**
* @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 $a->config
*
* @param string $family The category of the configuration value
*
* @return void
2019-01-06 21:06:53 +00:00
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function load($family = "config")
{
// Database isn't ready or populated yet
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
return;
}
2018-03-03 17:10:55 +00:00
if (empty(self::$adapter)) {
self::init();
}
2018-03-03 17:10:55 +00:00
self::$adapter->load($family);
}
/**
* @brief Get a particular user's config variable given the category name
* ($family) and a key.
*
* Get a particular config value from the given category ($family)
* and the $key from a cached storage in $a->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.
*
* @param string $family 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
2019-01-06 21:06:53 +00:00
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function get($family, $key, $default_value = null, $refresh = false)
{
// Database isn't ready or populated yet, fallback to file config
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
return self::getApp()->getConfigValue($family, $key, $default_value);
}
2018-03-03 17:10:55 +00:00
if (empty(self::$adapter)) {
self::init();
}
2018-03-03 17:10:55 +00:00
return self::$adapter->get($family, $key, $default_value, $refresh);
}
/**
* @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!
*
* @param string $family The category of the configuration value
* @param string $key The configuration key to set
* @param mixed $value The value to store
*
* @return bool Operation success
2019-01-06 21:06:53 +00:00
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function set($family, $key, $value)
{
// Database isn't ready or populated yet
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
return false;
}
2018-03-03 17:10:55 +00:00
if (empty(self::$adapter)) {
self::init();
2016-10-22 10:33:18 +00:00
}
2018-03-03 17:10:55 +00:00
return self::$adapter->set($family, $key, $value);
}
/**
* @brief Deletes the given key from the system configuration.
*
* Removes the configured value from the stored cache in $a->config
* and removes it from the database.
*
* @param string $family The category of the configuration value
* @param string $key The configuration key to delete
*
* @return mixed
2019-01-06 21:06:53 +00:00
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function delete($family, $key)
{
// Database isn't ready or populated yet
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
return false;
}
2018-03-03 17:10:55 +00:00
if (empty(self::$adapter)) {
self::init();
2016-10-22 10:33:18 +00:00
}
2018-03-03 17:10:55 +00:00
return self::$adapter->delete($family, $key);
}
}