From b791cc987e442f8e8c002975217bca417be53114 Mon Sep 17 00:00:00 2001 From: Maxence Lange Date: Tue, 3 Dec 2024 18:49:46 -0100 Subject: [PATCH] fix(NCU): removing all @since Signed-off-by: Maxence Lange --- .../Exceptions/IncorrectTypeException.php | 1 - .../Exceptions/TypeConflictException.php | 1 - .../Config/Exceptions/UnknownKeyException.php | 1 - lib/unstable/Config/IUserConfig.php | 43 ------------------- lib/unstable/Config/ValueType.php | 9 ---- 5 files changed, 55 deletions(-) diff --git a/lib/unstable/Config/Exceptions/IncorrectTypeException.php b/lib/unstable/Config/Exceptions/IncorrectTypeException.php index a5e4954cdb21c..274c95d732ad2 100644 --- a/lib/unstable/Config/Exceptions/IncorrectTypeException.php +++ b/lib/unstable/Config/Exceptions/IncorrectTypeException.php @@ -12,7 +12,6 @@ /** * @experimental 31.0.0 - * @since 31.0.0 */ class IncorrectTypeException extends Exception { } diff --git a/lib/unstable/Config/Exceptions/TypeConflictException.php b/lib/unstable/Config/Exceptions/TypeConflictException.php index c192b2c4f9dff..c6825b7efcfc5 100644 --- a/lib/unstable/Config/Exceptions/TypeConflictException.php +++ b/lib/unstable/Config/Exceptions/TypeConflictException.php @@ -12,7 +12,6 @@ /** * @experimental 31.0.0 - * @since 31.0.0 */ class TypeConflictException extends Exception { } diff --git a/lib/unstable/Config/Exceptions/UnknownKeyException.php b/lib/unstable/Config/Exceptions/UnknownKeyException.php index 5f83800cafcb9..a3ca88a7b72a1 100644 --- a/lib/unstable/Config/Exceptions/UnknownKeyException.php +++ b/lib/unstable/Config/Exceptions/UnknownKeyException.php @@ -12,7 +12,6 @@ /** * @experimental 31.0.0 - * @since 31.0.0 */ class UnknownKeyException extends Exception { } diff --git a/lib/unstable/Config/IUserConfig.php b/lib/unstable/Config/IUserConfig.php index 56ba797b9ddb2..b9cbb65ad03ec 100644 --- a/lib/unstable/Config/IUserConfig.php +++ b/lib/unstable/Config/IUserConfig.php @@ -28,17 +28,14 @@ * during specific requests or actions to avoid loading the lazy values all the time. * * @experimental 31.0.0 - * @since 31.0.0 */ interface IUserConfig { /** * @experimental 31.0.0 - * @since 31.0.0 */ public const FLAG_SENSITIVE = 1; // value is sensitive /** * @experimental 31.0.0 - * @since 31.0.0 */ public const FLAG_INDEXED = 2; // value should be indexed @@ -53,7 +50,6 @@ interface IUserConfig { * @return list list of userIds * * @experimental 31.0.0 - * @since 31.0.0 */ public function getUserIds(string $appId = ''): array; @@ -68,7 +64,6 @@ public function getUserIds(string $appId = ''): array; * @return list list of app ids * * @experimental 31.0.0 - * @since 31.0.0 */ public function getApps(string $userId): array; @@ -84,7 +79,6 @@ public function getApps(string $userId): array; * @return list list of stored config keys * * @experimental 31.0.0 - * @since 31.0.0 */ public function getKeys(string $userId, string $app): array; @@ -99,7 +93,6 @@ public function getKeys(string $userId, string $app): array; * @return bool TRUE if key exists * * @experimental 31.0.0 - * @since 31.0.0 */ public function hasKey(string $userId, string $app, string $key, ?bool $lazy = false): bool; @@ -115,7 +108,6 @@ public function hasKey(string $userId, string $app, string $key, ?bool $lazy = f * @throws UnknownKeyException if config key is not known * * @experimental 31.0.0 - * @since 31.0.0 */ public function isSensitive(string $userId, string $app, string $key, ?bool $lazy = false): bool; @@ -136,7 +128,6 @@ public function isSensitive(string $userId, string $app, string $key, ?bool $laz * @throws UnknownKeyException if config key is not known * * @experimental 31.0.0 - * @since 31.0.0 */ public function isIndexed(string $userId, string $app, string $key, ?bool $lazy = false): bool; @@ -154,7 +145,6 @@ public function isIndexed(string $userId, string $app, string $key, ?bool $lazy * @see IUserConfig for details about lazy loading * * @experimental 31.0.0 - * @since 31.0.0 */ public function isLazy(string $userId, string $app, string $key): bool; @@ -172,7 +162,6 @@ public function isLazy(string $userId, string $app, string $key): bool; * @return array [key => value] * * @experimental 31.0.0 - * @since 31.0.0 */ public function getValues(string $userId, string $app, string $prefix = '', bool $filtered = false): array; @@ -188,7 +177,6 @@ public function getValues(string $userId, string $app, string $prefix = '', bool * @return array [key => value] * * @experimental 31.0.0 - * @since 31.0.0 */ public function getAllValues(string $userId, bool $filtered = false): array; @@ -204,7 +192,6 @@ public function getAllValues(string $userId, bool $filtered = false): array; * @return array [appId => value] * * @experimental 31.0.0 - * @since 31.0.0 */ public function getValuesByApps(string $userId, string $key, bool $lazy = false, ?ValueType $typedAs = null): array; @@ -222,7 +209,6 @@ public function getValuesByApps(string $userId, string $key, bool $lazy = false, * @return array [userId => value] * * @experimental 31.0.0 - * @since 31.0.0 */ public function getValuesByUsers(string $app, string $key, ?ValueType $typedAs = null, ?array $userIds = null): array; @@ -240,7 +226,6 @@ public function getValuesByUsers(string $app, string $key, ?ValueType $typedAs = * @return Generator * * @experimental 31.0.0 - * @since 31.0.0 */ public function searchUsersByValueString(string $app, string $key, string $value, bool $caseInsensitive = false): Generator; @@ -257,7 +242,6 @@ public function searchUsersByValueString(string $app, string $key, string $value * @return Generator * * @experimental 31.0.0 - * @since 31.0.0 */ public function searchUsersByValueInt(string $app, string $key, int $value): Generator; @@ -274,7 +258,6 @@ public function searchUsersByValueInt(string $app, string $key, int $value): Gen * @return Generator * * @experimental 31.0.0 - * @since 31.0.0 */ public function searchUsersByValues(string $app, string $key, array $values): Generator; @@ -291,7 +274,6 @@ public function searchUsersByValues(string $app, string $key, array $values): Ge * @return Generator * * @experimental 31.0.0 - * @since 31.0.0 */ public function searchUsersByValueBool(string $app, string $key, bool $value): Generator; @@ -309,7 +291,6 @@ public function searchUsersByValueBool(string $app, string $key, bool $value): G * @return string stored config value or $default if not set in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see getValueInt() @@ -333,7 +314,6 @@ public function getValueString(string $userId, string $app, string $key, string * @return int stored config value or $default if not set in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see getValueString() @@ -357,7 +337,6 @@ public function getValueInt(string $userId, string $app, string $key, int $defau * @return float stored config value or $default if not set in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see getValueString() @@ -381,7 +360,6 @@ public function getValueFloat(string $userId, string $app, string $key, float $d * @return bool stored config value or $default if not set in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserPrefences for explanation about lazy loading * @see getValueString() @@ -405,7 +383,6 @@ public function getValueBool(string $userId, string $app, string $key, bool $def * @return array stored config value or $default if not set in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see getValueString() @@ -431,7 +408,6 @@ public function getValueArray(string $userId, string $app, string $key, array $d * @throws IncorrectTypeException if config value type is not known * * @experimental 31.0.0 - * @since 31.0.0 */ public function getValueType(string $userId, string $app, string $key, ?bool $lazy = null): ValueType; @@ -451,7 +427,6 @@ public function getValueType(string $userId, string $app, string $key, ?bool $la * @throws IncorrectTypeException if config value type is not known * * @experimental 31.0.0 - * @since 31.0.0 */ public function getValueFlags(string $userId, string $app, string $key, bool $lazy = false): int; @@ -473,7 +448,6 @@ public function getValueFlags(string $userId, string $app, string $key, bool $la * @return bool TRUE if value was different, therefor updated in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see setValueInt() @@ -506,7 +480,6 @@ public function setValueString(string $userId, string $app, string $key, string * @return bool TRUE if value was different, therefor updated in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see setValueString() @@ -534,7 +507,6 @@ public function setValueInt(string $userId, string $app, string $key, int $value * @return bool TRUE if value was different, therefor updated in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see setValueString() @@ -561,7 +533,6 @@ public function setValueFloat(string $userId, string $app, string $key, float $v * @return bool TRUE if value was different, therefor updated in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see setValueString() @@ -589,7 +560,6 @@ public function setValueBool(string $userId, string $app, string $key, bool $val * @return bool TRUE if value was different, therefor updated in database * * @experimental 31.0.0 - * @since 31.0.0 * * @see IUserConfig for explanation about lazy loading * @see setValueString() @@ -612,7 +582,6 @@ public function setValueArray(string $userId, string $app, string $key, array $v * @return bool TRUE if database update were necessary * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateSensitive(string $userId, string $app, string $key, bool $sensitive): bool; @@ -626,7 +595,6 @@ public function updateSensitive(string $userId, string $app, string $key, bool $ * @param bool $sensitive TRUE to set as sensitive, FALSE to unset * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateGlobalSensitive(string $app, string $key, bool $sensitive): void; @@ -644,7 +612,6 @@ public function updateGlobalSensitive(string $app, string $key, bool $sensitive) * @return bool TRUE if database update were necessary * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateIndexed(string $userId, string $app, string $key, bool $indexed): bool; @@ -658,7 +625,6 @@ public function updateIndexed(string $userId, string $app, string $key, bool $in * @param bool $indexed TRUE to set as indexed, FALSE to unset * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateGlobalIndexed(string $app, string $key, bool $indexed): void; @@ -673,7 +639,6 @@ public function updateGlobalIndexed(string $app, string $key, bool $indexed): vo * @return bool TRUE if database update was necessary * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateLazy(string $userId, string $app, string $key, bool $lazy): bool; @@ -687,7 +652,6 @@ public function updateLazy(string $userId, string $app, string $key, bool $lazy) * @param bool $lazy TRUE to set as lazy loaded, FALSE to unset * * @experimental 31.0.0 - * @since 31.0.0 */ public function updateGlobalLazy(string $app, string $key, bool $lazy): void; @@ -714,7 +678,6 @@ public function updateGlobalLazy(string $app, string $key, bool $lazy): void; * @throws UnknownKeyException if config key is not known in database * * @experimental 31.0.0 - * @since 31.0.0 */ public function getDetails(string $userId, string $app, string $key): array; @@ -726,7 +689,6 @@ public function getDetails(string $userId, string $app, string $key): array; * @param string $key config key * * @experimental 31.0.0 - * @since 31.0.0 */ public function deleteUserConfig(string $userId, string $app, string $key): void; @@ -737,7 +699,6 @@ public function deleteUserConfig(string $userId, string $app, string $key): void * @param string $key config key * * @experimental 31.0.0 - * @since 31.0.0 */ public function deleteKey(string $app, string $key): void; @@ -747,7 +708,6 @@ public function deleteKey(string $app, string $key): void; * @param string $app id of the app * * @experimental 31.0.0 - * @since 31.0.0 */ public function deleteApp(string $app): void; @@ -757,7 +717,6 @@ public function deleteApp(string $app): void; * @param string $userId id of the user * * @experimental 31.0.0 - * @since 31.0.0 */ public function deleteAllUserConfig(string $userId): void; @@ -770,7 +729,6 @@ public function deleteAllUserConfig(string $userId): void; * @param bool $reload set to TRUE to refill cache instantly after clearing it * * @experimental 31.0.0 - * @since 31.0.0 */ public function clearCache(string $userId, bool $reload = false): void; @@ -779,7 +737,6 @@ public function clearCache(string $userId, bool $reload = false): void; * The cache will be rebuilt only the next time a user config is requested. * * @experimental 31.0.0 - * @since 31.0.0 */ public function clearCacheAll(): void; } diff --git a/lib/unstable/Config/ValueType.php b/lib/unstable/Config/ValueType.php index eddfda4c14e5f..4f6c4181a9c76 100644 --- a/lib/unstable/Config/ValueType.php +++ b/lib/unstable/Config/ValueType.php @@ -15,37 +15,30 @@ * Listing of available value type for typed config value * * @experimental 31.0.0 - * @since 31.0.0 */ enum ValueType: int { /** * @experimental 31.0.0 - * @since 31.0.0 */ case MIXED = 0; /** * @experimental 31.0.0 - * @since 31.0.0 */ case STRING = 1; /** * @experimental 31.0.0 - * @since 31.0.0 */ case INT = 2; /** * @experimental 31.0.0 - * @since 31.0.0 */ case FLOAT = 3; /** * @experimental 31.0.0 - * @since 31.0.0 */ case BOOL = 4; /** * @experimental 31.0.0 - * @since 31.0.0 */ case ARRAY = 5; @@ -58,7 +51,6 @@ enum ValueType: int { * @throws IncorrectTypeException * * @experimental 31.0.0 - * @since 31.0.0 */ public static function fromStringDefinition(string $definition): self { try { @@ -82,7 +74,6 @@ public static function fromStringDefinition(string $definition): self { * @throws IncorrectTypeException * * @experimental 31.0.0 - * @since 31.0.0 */ public function getDefinition(): string { try {