mirror of
https://github.com/nextcloud/server.git
synced 2024-12-28 07:58:42 +00:00
bdce5921f6
It is returning a list of strings so adjust the return typing to reflect this (`list<string>` instead of `array`). Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
254 lines
8.3 KiB
PHP
254 lines
8.3 KiB
PHP
<?php
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
// use OCP namespace for all classes that are considered public.
|
|
// This means that they should be used by apps instead of the internal Nextcloud classes
|
|
|
|
namespace OCP;
|
|
|
|
/**
|
|
* Access to all the configuration options Nextcloud offers.
|
|
* @since 6.0.0
|
|
*/
|
|
interface IConfig {
|
|
/**
|
|
* @since 8.2.0
|
|
*/
|
|
public const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***';
|
|
|
|
/**
|
|
* Sets and deletes system wide values
|
|
*
|
|
* @param array $configs Associative array with `key => value` pairs
|
|
* If value is null, the config key will be deleted
|
|
* @throws HintException if config file is read-only
|
|
* @since 8.0.0
|
|
*/
|
|
public function setSystemValues(array $configs);
|
|
|
|
/**
|
|
* Sets a new system wide value
|
|
*
|
|
* @param string $key the key of the value, under which will be saved
|
|
* @param mixed $value the value that should be stored
|
|
* @throws HintException if config file is read-only
|
|
* @since 8.0.0
|
|
*/
|
|
public function setSystemValue($key, $value);
|
|
|
|
/**
|
|
* Looks up a system wide defined value
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param mixed $default the default value to be returned if the value isn't set
|
|
* @return mixed the value or $default
|
|
* @since 6.0.0 - parameter $default was added in 7.0.0
|
|
*/
|
|
public function getSystemValue($key, $default = '');
|
|
|
|
/**
|
|
* Looks up a boolean system wide defined value
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param bool $default the default value to be returned if the value isn't set
|
|
* @return bool the value or $default
|
|
* @since 16.0.0
|
|
*/
|
|
public function getSystemValueBool(string $key, bool $default = false): bool;
|
|
|
|
/**
|
|
* Looks up an integer system wide defined value
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param int $default the default value to be returned if the value isn't set
|
|
* @return int the value or $default
|
|
* @since 16.0.0
|
|
*/
|
|
public function getSystemValueInt(string $key, int $default = 0): int;
|
|
|
|
/**
|
|
* Looks up a string system wide defined value
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param string $default the default value to be returned if the value isn't set
|
|
* @return string the value or $default
|
|
* @since 16.0.0
|
|
*/
|
|
public function getSystemValueString(string $key, string $default = ''): string;
|
|
|
|
/**
|
|
* Looks up a system wide defined value and filters out sensitive data
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param mixed $default the default value to be returned if the value isn't set
|
|
* @return mixed the value or $default
|
|
* @since 8.2.0
|
|
*/
|
|
public function getFilteredSystemValue($key, $default = '');
|
|
|
|
/**
|
|
* Delete a system wide defined value
|
|
*
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @since 8.0.0
|
|
*/
|
|
public function deleteSystemValue($key);
|
|
|
|
/**
|
|
* Get all keys stored for an app
|
|
*
|
|
* @param string $appName the appName that we stored the value under
|
|
* @return string[] the keys stored for the app
|
|
* @since 8.0.0
|
|
* @deprecated 29.0.0 Use {@see IAppConfig} directly
|
|
*/
|
|
public function getAppKeys($appName);
|
|
|
|
/**
|
|
* Writes a new app wide value
|
|
*
|
|
* @param string $appName the appName that we want to store the value under
|
|
* @param string|float|int $key the key of the value, under which will be saved
|
|
* @param string $value the value that should be stored
|
|
* @return void
|
|
* @since 6.0.0
|
|
* @deprecated 29.0.0 Use {@see IAppConfig} directly
|
|
*/
|
|
public function setAppValue($appName, $key, $value);
|
|
|
|
/**
|
|
* Looks up an app wide defined value
|
|
*
|
|
* @param string $appName the appName that we stored the value under
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @param string $default the default value to be returned if the value isn't set
|
|
*
|
|
* @return string the saved value
|
|
* @since 6.0.0 - parameter $default was added in 7.0.0
|
|
* @deprecated 29.0.0 Use {@see IAppConfig} directly
|
|
*/
|
|
public function getAppValue($appName, $key, $default = '');
|
|
|
|
/**
|
|
* Delete an app wide defined value
|
|
*
|
|
* @param string $appName the appName that we stored the value under
|
|
* @param string $key the key of the value, under which it was saved
|
|
* @since 8.0.0
|
|
* @deprecated 29.0.0 Use {@see IAppConfig} directly
|
|
*/
|
|
public function deleteAppValue($appName, $key);
|
|
|
|
/**
|
|
* Removes all keys in appconfig belonging to the app
|
|
*
|
|
* @param string $appName the appName the configs are stored under
|
|
* @since 8.0.0
|
|
* @deprecated 29.0.0 Use {@see IAppConfig} directly
|
|
*/
|
|
public function deleteAppValues($appName);
|
|
|
|
|
|
/**
|
|
* Set a user defined value
|
|
*
|
|
* @param string $userId the userId of the user that we want to store the value under
|
|
* @param string $appName the appName that we want to store the value under
|
|
* @param string $key the key under which the value is being stored
|
|
* @param string $value the value that you want to store
|
|
* @param string $preCondition only update if the config value was previously the value passed as $preCondition
|
|
* @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
|
|
* @throws \UnexpectedValueException when trying to store an unexpected value
|
|
* @since 6.0.0 - parameter $precondition was added in 8.0.0
|
|
*/
|
|
public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
|
|
|
|
/**
|
|
* Shortcut for getting a user defined value
|
|
*
|
|
* @param ?string $userId the userId of the user that we want to store the value under
|
|
* @param string $appName the appName that we stored the value under
|
|
* @param string $key the key under which the value is being stored
|
|
* @param mixed $default the default value to be returned if the value isn't set
|
|
* @return string
|
|
* @since 6.0.0 - parameter $default was added in 7.0.0
|
|
*/
|
|
public function getUserValue($userId, $appName, $key, $default = '');
|
|
|
|
/**
|
|
* Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
|
|
*
|
|
* @param string $appName app to get the value for
|
|
* @param string $key the key to get the value for
|
|
* @param array $userIds the user IDs to fetch the values for
|
|
* @return array Mapped values: userId => value
|
|
* @since 8.0.0
|
|
*/
|
|
public function getUserValueForUsers($appName, $key, $userIds);
|
|
|
|
/**
|
|
* Get the keys of all stored by an app for the user
|
|
*
|
|
* @param string $userId the userId of the user that we want to store the value under
|
|
* @param string $appName the appName that we stored the value under
|
|
* @return string[]
|
|
* @since 8.0.0
|
|
*/
|
|
public function getUserKeys($userId, $appName);
|
|
|
|
/**
|
|
* Get all user configs sorted by app of one user
|
|
*
|
|
* @param string $userId the userId of the user that we want to get all values from
|
|
* @psalm-return array<string, array<string, string>>
|
|
* @return array[] - 2 dimensional array with the following structure:
|
|
* [ $appId =>
|
|
* [ $key => $value ]
|
|
* ]
|
|
* @since 24.0.0
|
|
*/
|
|
public function getAllUserValues(string $userId): array;
|
|
|
|
/**
|
|
* Delete a user value
|
|
*
|
|
* @param string $userId the userId of the user that we want to store the value under
|
|
* @param string $appName the appName that we stored the value under
|
|
* @param string $key the key under which the value is being stored
|
|
* @since 8.0.0
|
|
*/
|
|
public function deleteUserValue($userId, $appName, $key);
|
|
|
|
/**
|
|
* Delete all user values
|
|
*
|
|
* @param string $userId the userId of the user that we want to remove all values from
|
|
* @since 8.0.0
|
|
*/
|
|
public function deleteAllUserValues($userId);
|
|
|
|
/**
|
|
* Delete all user related values of one app
|
|
*
|
|
* @param string $appName the appName of the app that we want to remove all values from
|
|
* @since 8.0.0
|
|
*/
|
|
public function deleteAppFromAllUsers($appName);
|
|
|
|
/**
|
|
* Determines the users that have the given value set for a specific app-key-pair
|
|
*
|
|
* @param string $appName the app to get the user for
|
|
* @param string $key the key to get the user for
|
|
* @param string $value the value to get the user for
|
|
* @return list<string> of user IDs
|
|
* @since 31.0.0 return type of `list<string>`
|
|
* @since 8.0.0
|
|
*/
|
|
public function getUsersForUserValue($appName, $key, $value);
|
|
}
|