petru/nextcloud-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(lexicon): missing doc

Browse Source 
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange
2025-07-24 13:11:35 -01:00
parent a0c9fede1b
commit f359904213
11 changed files with 101 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/public/Config/IUserConfig.php
+2
View File
@@ -9,6 +9,7 @@ declare(strict_types=1);
namespace OCP\Config;
use Generator;
use OCP\AppFramework\Attribute\Consumable;
use OCP\Config\Exceptions\IncorrectTypeException;
use OCP\Config\Exceptions\UnknownKeyException;
@@ -29,6 +30,7 @@ use OCP\Config\Exceptions\UnknownKeyException;
*
* @since 32.0.0
*/
#[Consumable(since: '32.0.0')]
interface IUserConfig {
/**
* @since 32.0.0
lib/public/Config/Lexicon/ILexicon.php
+5
View File
@@ -8,12 +8,17 @@ declare(strict_types=1);
namespace OCP\Config\Lexicon;
use OCP\AppFramework\Attribute\Consumable;
use OCP\AppFramework\Attribute\Implementable;
/**
* This interface needs to be implemented if you want to define a config lexicon for your application
* The config lexicon is used to avoid conflicts and problems when storing/retrieving config values
*
* @since 32.0.0
*/
#[Consumable(since: '32.0.0')]
#[Implementable(since: '32.0.0')]
interface ILexicon {
/**
lib/unstable/Config/Exceptions/IncorrectTypeException.php
+1 -1
View File
@@ -12,7 +12,7 @@ use Exception;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Exceptions\IncorrectTypeException
* @deprecated 32.0.0 use \OCP\Config\Exceptions\IncorrectTypeException
* @see \OCP\Config\Exceptions\IncorrectTypeException
*/
class IncorrectTypeException extends Exception {
lib/unstable/Config/Exceptions/TypeConflictException.php
+1 -1
View File
@@ -12,7 +12,7 @@ use Exception;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Exceptions\TypeConflictException
* @deprecated 32.0.0 use \OCP\Config\Exceptions\TypeConflictException
* @see \OCP\Config\Exceptions\TypeConflictException
*/
class TypeConflictException extends Exception {
lib/unstable/Config/Exceptions/UnknownKeyException.php
+1 -1
View File
@@ -12,7 +12,7 @@ use Exception;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Exceptions\UnknownKeyException
* @deprecated 32.0.0 use \OCP\Config\Exceptions\UnknownKeyException
* @see \OCP\Config\Exceptions\UnknownKeyException
*/
class UnknownKeyException extends Exception {
lib/unstable/Config/IUserConfig.php
+43 -43
View File
@@ -28,19 +28,19 @@ use NCU\Config\Exceptions\UnknownKeyException;
* during specific requests or actions to avoid loading the lazy values all the time.
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
interface IUserConfig {
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public const FLAG_SENSITIVE = 1; // value is sensitive
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public const FLAG_INDEXED = 2; // value should be indexed
@@ -56,7 +56,7 @@ interface IUserConfig {
* @return list<string> list of userIds
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getUserIds(string $appId = ''): array;
@@ -72,7 +72,7 @@ interface IUserConfig {
* @return list<string> list of app ids
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getApps(string $userId): array;
@@ -89,7 +89,7 @@ interface IUserConfig {
* @return list<string> list of stored config keys
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getKeys(string $userId, string $app): array;
@@ -105,7 +105,7 @@ interface IUserConfig {
* @return bool TRUE if key exists
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function hasKey(string $userId, string $app, string $key, ?bool $lazy = false): bool;
@@ -122,7 +122,7 @@ interface IUserConfig {
* @throws UnknownKeyException if config key is not known
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function isSensitive(string $userId, string $app, string $key, ?bool $lazy = false): bool;
@@ -144,7 +144,7 @@ interface IUserConfig {
* @throws UnknownKeyException if config key is not known
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function isIndexed(string $userId, string $app, string $key, ?bool $lazy = false): bool;
@@ -163,7 +163,7 @@ interface IUserConfig {
* @see IUserConfig for details about lazy loading
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function isLazy(string $userId, string $app, string $key): bool;
@@ -182,7 +182,7 @@ interface IUserConfig {
* @return array<string, string|int|float|bool|array> [key => value]
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getValues(string $userId, string $app, string $prefix = '', bool $filtered = false): array;
@@ -199,7 +199,7 @@ interface IUserConfig {
* @return array<string, string|int|float|bool|array> [key => value]
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getAllValues(string $userId, bool $filtered = false): array;
@@ -216,7 +216,7 @@ interface IUserConfig {
* @return array<string, string|int|float|bool|array> [appId => value]
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
* @psalm-suppress DeprecatedClass
*/
@@ -236,7 +236,7 @@ interface IUserConfig {
* @return array<string, string|int|float|bool|array> [userId => value]
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
* @psalm-suppress DeprecatedClass
*/
@@ -256,7 +256,7 @@ interface IUserConfig {
* @return Generator<string>
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function searchUsersByValueString(string $app, string $key, string $value, bool $caseInsensitive = false): Generator;
@@ -274,7 +274,7 @@ interface IUserConfig {
* @return Generator<string>
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function searchUsersByValueInt(string $app, string $key, int $value): Generator;
@@ -292,7 +292,7 @@ interface IUserConfig {
* @return Generator<string>
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function searchUsersByValues(string $app, string $key, array $values): Generator;
@@ -310,7 +310,7 @@ interface IUserConfig {
* @return Generator<string>
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function searchUsersByValueBool(string $app, string $key, bool $value): Generator;
@@ -329,7 +329,7 @@ interface IUserConfig {
* @return string stored config value or $default if not set in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -354,7 +354,7 @@ interface IUserConfig {
* @return int stored config value or $default if not set in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -379,7 +379,7 @@ interface IUserConfig {
* @return float stored config value or $default if not set in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -404,7 +404,7 @@ interface IUserConfig {
* @return bool stored config value or $default if not set in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserPrefences for explanation about lazy loading
@@ -429,7 +429,7 @@ interface IUserConfig {
* @return array stored config value or $default if not set in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -456,7 +456,7 @@ interface IUserConfig {
* @throws IncorrectTypeException if config value type is not known
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
* @psalm-suppress DeprecatedClass
*/
@@ -478,7 +478,7 @@ interface IUserConfig {
* @throws IncorrectTypeException if config value type is not known
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getValueFlags(string $userId, string $app, string $key, bool $lazy = false): int;
@@ -501,7 +501,7 @@ interface IUserConfig {
* @return bool TRUE if value was different, therefor updated in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -535,7 +535,7 @@ interface IUserConfig {
* @return bool TRUE if value was different, therefor updated in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -564,7 +564,7 @@ interface IUserConfig {
* @return bool TRUE if value was different, therefor updated in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -592,7 +592,7 @@ interface IUserConfig {
* @return bool TRUE if value was different, therefor updated in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -621,7 +621,7 @@ interface IUserConfig {
* @return bool TRUE if value was different, therefor updated in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*
* @see IUserConfig for explanation about lazy loading
@@ -645,7 +645,7 @@ interface IUserConfig {
* @return bool TRUE if database update were necessary
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateSensitive(string $userId, string $app, string $key, bool $sensitive): bool;
@@ -660,7 +660,7 @@ interface IUserConfig {
* @param bool $sensitive TRUE to set as sensitive, FALSE to unset
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateGlobalSensitive(string $app, string $key, bool $sensitive): void;
@@ -679,7 +679,7 @@ interface IUserConfig {
* @return bool TRUE if database update were necessary
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateIndexed(string $userId, string $app, string $key, bool $indexed): bool;
@@ -694,7 +694,7 @@ interface IUserConfig {
* @param bool $indexed TRUE to set as indexed, FALSE to unset
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateGlobalIndexed(string $app, string $key, bool $indexed): void;
@@ -710,7 +710,7 @@ interface IUserConfig {
* @return bool TRUE if database update was necessary
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateLazy(string $userId, string $app, string $key, bool $lazy): bool;
@@ -725,7 +725,7 @@ interface IUserConfig {
* @param bool $lazy TRUE to set as lazy loaded, FALSE to unset
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function updateGlobalLazy(string $app, string $key, bool $lazy): void;
@@ -753,7 +753,7 @@ interface IUserConfig {
* @throws UnknownKeyException if config key is not known in database
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function getDetails(string $userId, string $app, string $key): array;
@@ -766,7 +766,7 @@ interface IUserConfig {
* @param string $key config key
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function deleteUserConfig(string $userId, string $app, string $key): void;
@@ -778,7 +778,7 @@ interface IUserConfig {
* @param string $key config key
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function deleteKey(string $app, string $key): void;
@@ -789,7 +789,7 @@ interface IUserConfig {
* @param string $app id of the app
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function deleteApp(string $app): void;
@@ -800,7 +800,7 @@ interface IUserConfig {
* @param string $userId id of the user
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function deleteAllUserConfig(string $userId): void;
@@ -814,7 +814,7 @@ interface IUserConfig {
* @param bool $reload set to TRUE to refill cache instantly after clearing it
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function clearCache(string $userId, bool $reload = false): void;
@@ -824,7 +824,7 @@ interface IUserConfig {
* The cache will be rebuilt only the next time a user config is requested.
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\IUserConfig
* @deprecated 32.0.0 use \OCP\Config\IUserConfig
* @see \OCP\Config\IUserConfig
*/
public function clearCacheAll(): void;
lib/unstable/Config/Lexicon/ConfigLexiconEntry.php
+19 -19
View File
@@ -16,14 +16,14 @@ use NCU\Config\ValueType;
*
* @see IConfigLexicon
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress DeprecatedClass
*/
class ConfigLexiconEntry {
/**
* @experimental 32.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public const RENAME_INVERT_BOOLEAN = 1;
@@ -41,7 +41,7 @@ class ConfigLexiconEntry {
* @param bool $deprecated set config key as deprecated
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress PossiblyInvalidCast
* @psalm-suppress RiskyCast
@@ -73,7 +73,7 @@ class ConfigLexiconEntry {
*
* @return string config key
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function getKey(): string {
@@ -85,7 +85,7 @@ class ConfigLexiconEntry {
*
* @return ValueType
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress DeprecatedClass
*/
@@ -97,7 +97,7 @@ class ConfigLexiconEntry {
* @param string $default
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
private function convertFromString(string $default): string {
@@ -108,7 +108,7 @@ class ConfigLexiconEntry {
* @param int $default
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
private function convertFromInt(int $default): string {
@@ -119,7 +119,7 @@ class ConfigLexiconEntry {
* @param float $default
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
private function convertFromFloat(float $default): string {
@@ -130,7 +130,7 @@ class ConfigLexiconEntry {
* @param bool $default
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
private function convertFromBool(bool $default): string {
@@ -141,7 +141,7 @@ class ConfigLexiconEntry {
* @param array $default
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
private function convertFromArray(array $default): string {
@@ -153,7 +153,7 @@ class ConfigLexiconEntry {
*
* @return string|null NULL if no default is set
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress DeprecatedClass
* @psalm-suppress DeprecatedMethod
@@ -185,7 +185,7 @@ class ConfigLexiconEntry {
*
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress PossiblyInvalidCast arrays are managed pre-cast
* @psalm-suppress RiskyCast
@@ -214,7 +214,7 @@ class ConfigLexiconEntry {
*
* @return string
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function getDefinition(): string {
@@ -227,7 +227,7 @@ class ConfigLexiconEntry {
* @see IAppConfig for details on lazy config values
* @return bool TRUE if config value is lazy
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function isLazy(): bool {
@@ -240,7 +240,7 @@ class ConfigLexiconEntry {
* @see IAppConfig for details on sensitive config values
* @return int bitflag about the config value
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function getFlags(): int {
@@ -252,7 +252,7 @@ class ConfigLexiconEntry {
*
* @return bool TRUE is config value bitflag contains $flag
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @psalm-suppress DeprecatedMethod
*/
@@ -266,7 +266,7 @@ class ConfigLexiconEntry {
*
* @return string|null not NULL if value can be imported from a previous key
* @experimental 32.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function getRename(): ?string {
@@ -275,7 +275,7 @@ class ConfigLexiconEntry {
/**
* @experimental 32.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
* @return bool TRUE if $option was set during the creation of the entry.
*/
@@ -288,7 +288,7 @@ class ConfigLexiconEntry {
*
* @return bool TRUE if config si deprecated
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Entry
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Entry
* @see \OCP\Config\Lexicon\Entry
*/
public function isDeprecated(): bool {
lib/unstable/Config/Lexicon/ConfigLexiconStrictness.php
+5 -5
View File
@@ -17,31 +17,31 @@ namespace NCU\Config\Lexicon;
* - **ConfigLexiconStrictness::EXCEPTION** - block (throws exception) and report
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Strictness
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
* @see \OCP\Config\Lexicon\Strictness
*/
enum ConfigLexiconStrictness {
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Strictness
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
* @see \OCP\Config\Lexicon\Strictness
*/
case IGNORE; // fully ignore
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Strictness
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
* @see \OCP\Config\Lexicon\Strictness
*/
case NOTICE; // ignore and report
/**
* @deprecated use \OCP\Config\Lexicon\Strictness
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
* @see \OCP\Config\Lexicon\Strictness
* @experimental 31.0.0
*/
case WARNING; // silently block (returns $default) and report
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\Strictness
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Strictness
* @see \OCP\Config\Lexicon\Strictness
*/
case EXCEPTION; // block (throws exception) and report
lib/unstable/Config/Lexicon/IConfigLexicon.php
+4 -4
View File
@@ -13,7 +13,7 @@ namespace NCU\Config\Lexicon;
* The config lexicon is used to avoid conflicts and problems when storing/retrieving config values
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\ILexicon
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
* @see \OCP\Config\Lexicon\ILexicon
*/
interface IConfigLexicon {
@@ -24,7 +24,7 @@ interface IConfigLexicon {
*
* @return ConfigLexiconStrictness
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\ILexicon
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
* @see \OCP\Config\Lexicon\ILexicon
* @psalm-suppress DeprecatedClass
*
@@ -36,7 +36,7 @@ interface IConfigLexicon {
*
* @return ConfigLexiconEntry[]
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\ILexicon
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
* @see \OCP\Config\Lexicon\ILexicon
* @psalm-suppress DeprecatedClass
*/
@@ -47,7 +47,7 @@ interface IConfigLexicon {
*
* @return ConfigLexiconEntry[]
* @experimental 31.0.0
* @deprecated use \OCP\Config\Lexicon\ILexicon
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
* @see \OCP\Config\Lexicon\ILexicon
* @psalm-suppress DeprecatedClass
*/
lib/unstable/Config/Lexicon/Preset.php
+10 -10
View File
@@ -23,53 +23,53 @@ namespace NCU\Config\Lexicon;
* - **Preset::PRIVATE** - Private
*
* @experimental 32.0.0
* @deprecated use \OCP\Config\Lexicon\Preset
* @deprecated 32.0.0 use \OCP\Config\Lexicon\Preset
* @see \OCP\Config\Lexicon\Preset
*/
enum Preset: int {
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case LARGE = 8;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case MEDIUM = 7;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case SMALL = 6;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case SHARED = 5;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case EDUCATION = 4;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case CLUB = 3;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case FAMILY = 2;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case PRIVATE = 1;
/**
* @experimental 32.0.0
* @deprecated
* @deprecated 32.0.0
*/
case NONE = 0;
}
lib/unstable/Config/ValueType.php
+10 -10
View File
@@ -16,43 +16,43 @@ use UnhandledMatchError;
* Listing of available value type for typed config value
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
enum ValueType: int {
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case MIXED = 0;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case STRING = 1;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case INT = 2;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case FLOAT = 3;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case BOOL = 4;
/**
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
*/
case ARRAY = 5;
@@ -66,7 +66,7 @@ enum ValueType: int {
* @throws IncorrectTypeException
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
* @psalm-suppress DeprecatedConstant
* @psalm-suppress DeprecatedClass
@@ -93,7 +93,7 @@ enum ValueType: int {
* @throws IncorrectTypeException
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
* @psalm-suppress DeprecatedConstant
* @psalm-suppress DeprecatedClass
@@ -120,7 +120,7 @@ enum ValueType: int {
* @throws IncorrectTypeException
*
* @experimental 31.0.0
* @deprecated use \OCP\Config\ValueType
* @deprecated 32.0.0 use \OCP\Config\ValueType
* @see \OCP\Config\ValueType
* @psalm-suppress DeprecatedConstant
* @psalm-suppress DeprecatedClass