aboutsummaryrefslogtreecommitdiffstats
path: root/lib/unstable/Config/ValueType.php
blob: 4f6c4181a9c76b0c7b1c58efd5eb394581050746 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace NCU\Config;

use NCU\Config\Exceptions\IncorrectTypeException;
use UnhandledMatchError;

/**
 * Listing of available value type for typed config value
 *
 * @experimental 31.0.0
 */
enum ValueType: int {
	/**
	 * @experimental 31.0.0
	 */
	case MIXED = 0;
	/**
	 * @experimental 31.0.0
	 */
	case STRING = 1;
	/**
	 * @experimental 31.0.0
	 */
	case INT = 2;
	/**
	 * @experimental 31.0.0
	 */
	case FLOAT = 3;
	/**
	 * @experimental 31.0.0
	 */
	case BOOL = 4;
	/**
	 * @experimental 31.0.0
	 */
	case ARRAY = 5;

	/**
	 * get ValueType from string
	 *
	 * @param string $definition
	 *
	 * @return self
	 * @throws IncorrectTypeException
	 *
	 * @experimental 31.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
	 *
	 * @experimental 31.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);
		}
	}
}