friendica/src/Core/Config/PConfiguration.php

110 lines
3.3 KiB
PHP
Raw Normal View History

<?php
namespace Friendica\Core\Config;
2019-07-15 20:13:53 +02:00
use Friendica\Model;
/**
* This class is responsible for the user-specific configuration values in Friendica
2019-07-15 20:19:52 +02:00
* 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
* increase the performance.
*/
2019-07-15 20:13:53 +02:00
abstract class PConfiguration
{
/**
* @var Cache\PConfigCache
*/
2019-07-15 20:13:53 +02:00
protected $configCache;
/**
2019-07-15 20:13:53 +02:00
* @var Model\Config\PConfig
*/
2019-07-15 20:13:53 +02:00
protected $configModel;
/**
2019-07-15 20:13:53 +02:00
* @param Cache\PConfigCache $configCache The configuration cache
* @param Model\Config\PConfig $configModel The configuration model
*/
2019-07-15 20:13:53 +02:00
public function __construct(Cache\PConfigCache $configCache, Model\Config\PConfig $configModel)
{
$this->configCache = $configCache;
2019-07-15 20:13:53 +02:00
$this->configModel = $configModel;
}
/**
* Returns the Config Cache
*
* @return Cache\PConfigCache
*/
public function getCache()
{
return $this->configCache;
}
/**
2019-07-15 20:13:53 +02:00
* Loads all configuration values of a user's config family into a cached storage.
*
* All configuration values of the given user are stored with the $uid in the cache
*
* @param int $uid The user_id
* @param string $cat The category of the configuration value
*
* @return void
* @see PConfigCache
2019-07-15 20:13:53 +02:00
*
*/
abstract public function load(int $uid, string $cat = 'config');
/**
2019-07-15 20:13:53 +02:00
* Get a particular user's config variable given the category name
* ($cat) and a key.
*
* 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
* (@see IConfigAdapter) or from the $this->configCache (@see PConfigCache).
*
2019-07-15 20:19:52 +02:00
* @param int $uid The user_id
* @param string $cat 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
*/
abstract public function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false);
/**
2019-07-15 20:13:53 +02:00
* Sets a configuration value for a user
*
* 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!
*
2019-07-15 20:13:53 +02:00
* @param int $uid The user_id
* @param string $cat 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
*/
abstract public function set(int $uid, string $cat, string $key, $value);
/**
2019-07-15 20:13:53 +02:00
* Deletes the given key from the users's configuration.
*
* Removes the configured value from the stored cache in $this->configCache
* (@see ConfigCache) and removes it from the database (@see IConfigAdapter)
2019-07-15 20:19:52 +02:00
* with the given $uid.
*
2019-07-15 20:19:52 +02:00
* @param int $uid The user_id
* @param string $cat The category of the configuration value
* @param string $key The configuration key to delete
*
* @return bool
*/
abstract public function delete(int $uid, string $cat, string $key);
}