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
|
<?php
/**
* @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
*
* @author Kate Döen <kate.doeen@nextcloud.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Settings;
/**
* @since 29.0.0
*
* @psalm-type DeclarativeSettingsSectionType = 'admin'|'personal'
*
* @psalm-type DeclarativeSettingsStorageType = 'internal'|'external'
*
* @psalm-type DeclarativeSettingsValueTypes = string|int|float|bool|list<string>
*
* @psalm-type DeclarativeSettingsFormField = array{
* id: string,
* title: string,
* description?: string,
* type: 'text'|'password'|'email'|'tel'|'url'|'number'|'checkbox'|'multi-checkbox'|'radio'|'select'|'multi-select',
* placeholder?: string,
* label?: string,
* default: mixed,
* options?: list<string|array{name: string, value: mixed}>,
* }
*
* @psalm-type DeclarativeSettingsFormFieldWithValue = DeclarativeSettingsFormField&array{
* value: DeclarativeSettingsValueTypes,
* }
*
* @psalm-type DeclarativeSettingsFormSchema = array{
* id: string,
* priority: int,
* section_type: DeclarativeSettingsSectionType,
* section_id: string,
* storage_type: DeclarativeSettingsStorageType,
* title: string,
* description?: string,
* doc_url?: string,
* }
*
* @psalm-type DeclarativeSettingsFormSchemaWithValues = DeclarativeSettingsFormSchema&array{
* app: string,
* fields: list<DeclarativeSettingsFormFieldWithValue>,
* }
*
* @psalm-type DeclarativeSettingsFormSchemaWithoutValues = DeclarativeSettingsFormSchema&array{
* fields: list<DeclarativeSettingsFormField>,
* }
*/
interface IDeclarativeSettingsForm {
/**
* Gets the schema that defines the declarative settings form
*
* @return DeclarativeSettingsFormSchemaWithoutValues
* @since 29.0.0
*/
public function getSchema(): array;
}
|
