aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Config/ValueType.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Config/ValueType.php')
-rw-r--r--lib/public/Config/ValueType.php117
1 files changed, 117 insertions, 0 deletions
diff --git a/lib/public/Config/ValueType.php b/lib/public/Config/ValueType.php
new file mode 100644
index 00000000000..32c734af32b
--- /dev/null
+++ b/lib/public/Config/ValueType.php
@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Config;
+
+use OCP\AppFramework\Attribute\Consumable;
+use OCP\Config\Exceptions\IncorrectTypeException;
+use OCP\IAppConfig;
+use UnhandledMatchError;
+
+/**
+ * Listing of available value type for typed config value
+ */
+#[Consumable(since: '32.0.0')]
+enum ValueType: int {
+ /**
+ * @since 32.0.0
+ */
+ case MIXED = 0;
+ /**
+ * @since 32.0.0
+ */
+ case STRING = 1;
+ /**
+ * @since 32.0.0
+ */
+ case INT = 2;
+ /**
+ * @since 32.0.0
+ */
+ case FLOAT = 3;
+ /**
+ * @since 32.0.0
+ */
+ case BOOL = 4;
+ /**
+ * @since 32.0.0
+ */
+ case ARRAY = 5;
+
+ /**
+ * get ValueType from string
+ *
+ * @param string $definition
+ *
+ * @return self
+ * @throws IncorrectTypeException
+ *
+ * @since 32.0.0
+ */
+ public static function fromStringDefinition(string $definition): self {
+ try {
+ return match ($definition) {
+ 'mixed' => self::MIXED,
+ 'string' => self::STRING,
+ 'int' => self::INT,
+ 'float' => self::FLOAT,
+ 'bool' => self::BOOL,
+ 'array' => self::ARRAY
+ };
+ } catch (\UnhandledMatchError) {
+ throw new IncorrectTypeException('unknown string definition');
+ }
+ }
+
+ /**
+ * get string definition for current enum value
+ *
+ * @return string
+ * @throws IncorrectTypeException
+ *
+ * @since 32.0.0
+ */
+ public function getDefinition(): string {
+ try {
+ return match ($this) {
+ self::MIXED => 'mixed',
+ self::STRING => 'string',
+ self::INT => 'int',
+ self::FLOAT => 'float',
+ self::BOOL => 'bool',
+ self::ARRAY => 'array',
+ };
+ } catch (UnhandledMatchError) {
+ throw new IncorrectTypeException('unknown type definition ' . $this->value);
+ }
+ }
+
+ /**
+ * get corresponding AppConfig flag value
+ *
+ * @return int
+ * @throws IncorrectTypeException
+ *
+ * @since 32.0.0
+ */
+ public function toAppConfigFlag(): int {
+ try {
+ return match ($this) {
+ self::MIXED => IAppConfig::VALUE_MIXED,
+ self::STRING => IAppConfig::VALUE_STRING,
+ self::INT => IAppConfig::VALUE_INT,
+ self::FLOAT => IAppConfig::VALUE_FLOAT,
+ self::BOOL => IAppConfig::VALUE_BOOL,
+ self::ARRAY => IAppConfig::VALUE_ARRAY,
+ };
+ } catch (UnhandledMatchError) {
+ throw new IncorrectTypeException('unknown type definition ' . $this->value);
+ }
+ }
+
+}