blob: 584fee1e498596c1d667fbc3bb378d42f02b3104 (
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
<?php
/**
* SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCA\Files_External\Lib;
/**
* Parameter for an external storage definition
*/
class DefinitionParameter implements \JsonSerializable {
// placeholder value for password fields, when the client updates a storage configuration
// placeholder values are ignored and the field is left unmodified
public const UNMODIFIED_PLACEHOLDER = '__unmodified__';
/** Value constants */
public const VALUE_TEXT = 0;
public const VALUE_BOOLEAN = 1;
public const VALUE_PASSWORD = 2;
public const VALUE_HIDDEN = 3;
/** Flag constants */
public const FLAG_NONE = 0;
public const FLAG_OPTIONAL = 1;
public const FLAG_USER_PROVIDED = 2;
/** @var string name of parameter */
private string $name;
/** @var string human-readable parameter text */
private string $text;
/** @var string human-readable parameter tooltip */
private string $tooltip = '';
/** @var int value type, see self::VALUE_* constants */
private int $type = self::VALUE_TEXT;
/** @var int flags, see self::FLAG_* constants */
private int $flags = self::FLAG_NONE;
/** @var mixed */
private $defaultValue;
/**
* @param string $name parameter name
* @param string $text parameter description
* @param mixed $defaultValue default value
*/
public function __construct(string $name, string $text, $defaultValue = null) {
$this->name = $name;
$this->text = $text;
$this->defaultValue = $defaultValue;
}
/**
* @return string
*/
public function getName(): string {
return $this->name;
}
/**
* @return string
*/
public function getText(): string {
return $this->text;
}
/**
* Get value type
*
* @return int
*/
public function getType(): int {
return $this->type;
}
/**
* Set value type
*
* @param int $type
* @return self
*/
public function setType(int $type) {
$this->type = $type;
return $this;
}
/**
* @return mixed default value
*/
public function getDefaultValue() {
return $this->defaultValue;
}
/**
* @param mixed $defaultValue default value
* @return self
*/
public function setDefaultValue($defaultValue) {
$this->defaultValue = $defaultValue;
return $this;
}
/**
* @return string
*/
public function getTypeName(): string {
switch ($this->type) {
case self::VALUE_BOOLEAN:
return 'boolean';
case self::VALUE_TEXT:
return 'text';
case self::VALUE_PASSWORD:
return 'password';
default:
return 'unknown';
}
}
/**
* @return int
*/
public function getFlags(): int {
return $this->flags;
}
/**
* @param int $flags
* @return self
*/
public function setFlags(int $flags) {
$this->flags = $flags;
return $this;
}
/**
* @param int $flag
* @return self
*/
public function setFlag(int $flag) {
$this->flags |= $flag;
return $this;
}
/**
* @param int $flag
* @return bool
*/
public function isFlagSet(int $flag): bool {
return (bool)($this->flags & $flag);
}
/**
* @return string
*/
public function getTooltip(): string {
return $this->tooltip;
}
/**
* @param string $tooltip
* @return self
*/
public function setTooltip(string $tooltip) {
$this->tooltip = $tooltip;
return $this;
}
/**
* Serialize into JSON for client-side JS
*/
public function jsonSerialize(): array {
$result = [
'value' => $this->getText(),
'flags' => $this->getFlags(),
'type' => $this->getType(),
'tooltip' => $this->getTooltip(),
];
$defaultValue = $this->getDefaultValue();
if ($defaultValue) {
$result['defaultValue'] = $defaultValue;
}
return $result;
}
public function isOptional(): bool {
return $this->isFlagSet(self::FLAG_OPTIONAL) || $this->isFlagSet(self::FLAG_USER_PROVIDED);
}
/**
* Validate a parameter value against this
* Convert type as necessary
*
* @param mixed $value Value to check
* @return bool success
*/
public function validateValue(&$value): bool {
switch ($this->getType()) {
case self::VALUE_BOOLEAN:
if (!is_bool($value)) {
switch ($value) {
case 'true':
$value = true;
break;
case 'false':
$value = false;
break;
default:
return false;
}
}
break;
default:
if (!$value && !$this->isOptional()) {
return false;
}
break;
}
return true;
}
}
|
