mirror of
https://git.sekbaer.de/Friendica/friendica.git
synced 2025-06-10 17:14:26 +02:00
23dda5d510
- It is more efficient to use the null coalescing operator ?? that prevents the computation of the default value if the key has been found
99 lines
3.3 KiB
PHP
99 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2022, the Friendica project
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Core\PConfig\Capability;
|
|
|
|
use Friendica\Core\PConfig\ValueObject;
|
|
|
|
/**
|
|
* Interface for accessing user specific configurations
|
|
*/
|
|
interface IManagePersonalConfigValues
|
|
{
|
|
/**
|
|
* 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 array The loaded config array
|
|
*/
|
|
public function load(int $uid, string $cat = 'config'): array;
|
|
|
|
/**
|
|
* 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 database
|
|
* or from the configCache
|
|
*
|
|
* @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 Deprecated, use `PConfig->get($uid, $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
|
|
*
|
|
*/
|
|
public function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false);
|
|
|
|
/**
|
|
* 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 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
|
|
*/
|
|
public function set(int $uid, string $cat, string $key, $value): bool;
|
|
|
|
/**
|
|
* Deletes the given key from the users configuration.
|
|
*
|
|
* Removes the configured value from the stored cache and removes it from the database with the given $uid.
|
|
*
|
|
* @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
|
|
*/
|
|
public function delete(int $uid, string $cat, string $key): bool;
|
|
|
|
|
|
/**
|
|
* Returns the Config Cache
|
|
*
|
|
* @return ValueObject\Cache
|
|
*/
|
|
public function getCache(): ValueObject\Cache;
|
|
}
|