friendica/src/Core/PConfig.php

<?php
/**
 * User Configuration Class
 *
 * @file include/Core/PConfig.php
 *
 * @brief Contains the class with methods for user configuration
 */
namespace Friendica\Core;

/**
 * @brief Management of user configuration storage
 * Note:
 * Please do not store booleans - convert to 0/1 integer values
 * The PConfig::get() functions return boolean false for keys that are unset,
 * and this could lead to subtle bugs.
 */
class PConfig
{
	/**
	 * @var Config\IPConfigAdapter
	 */
	private static $adapter;

	/**
	 * @var Config\IPConfigCache
	 */
	private static $cache;

	/**
	 * Initialize the config with only the cache
	 *
	 * @param Config\IPConfigCache $cache  The configuration cache
	 */
	public static function init(Config\IPConfigCache $cache)
	{
		self::$cache  = $cache;
	}

	/**
	 * Add the adapter for DB-backend
	 *
	 * @param Config\IPConfigAdapter $adapter
	 */
	public static function setAdapter(Config\IPConfigAdapter $adapter)
	{
		self::$adapter = $adapter;
	}

	/**
	 * @brief 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 ( @see IPConfigCache )
	 *
	 * @param string $uid    The user_id
	 * @param string $family The category of the configuration value
	 *
	 * @return void
	 */
	public static function load($uid, $family)
	{
		if (!isset(self::$adapter)) {
			return;
		}

		self::$adapter->load($uid, $family);
	}

	/**
	 * @brief Get a particular user's config variable given the category name
	 * ($family) and a key.
	 *
	 * Get a particular user's config value from the given category ($family)
	 * 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
	 * @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
	 */
	public static function get($uid, $family, $key, $default_value = null, $refresh = false)
	{
		if (!isset(self::$adapter)) {
			return self::$cache->getP($uid, $family, $key, $default_value);
		}

		return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
	}

	/**
	 * @brief 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!
	 *
	 * @param string $uid    The user_id
	 * @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
	 */
	public static function set($uid, $family, $key, $value)
	{
		if (!isset(self::$adapter)) {
			return self::$cache->setP($uid, $family, $key, $value);
		}

		return self::$adapter->set($uid, $family, $key, $value);
	}

	/**
	 * @brief Deletes the given key from the users's configuration.
	 *
	 * 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
	 * @param string $key    The configuration key to delete
	 *
	 * @return mixed
	 */
	public static function delete($uid, $family, $key)
	{
		if (!isset(self::$adapter)) {
			return self::$cache->deleteP($uid, $family, $key);
		}

		return self::$adapter->delete($uid, $family, $key);
	}
}