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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Testing\Settings;
use OCP\Settings\DeclarativeSettingsTypes;
use OCP\Settings\IDeclarativeSettingsForm;
class DeclarativeSettingsForm implements IDeclarativeSettingsForm {
public function getSchema(): array {
return [
'id' => 'test_declarative_form',
'priority' => 10,
'section_type' => DeclarativeSettingsTypes::SECTION_TYPE_ADMIN, // admin, personal
'section_id' => 'additional',
'storage_type' => DeclarativeSettingsTypes::STORAGE_TYPE_INTERNAL, // external, internal (handled by core to store in appconfig and preferences)
'title' => 'Test declarative settings class', // NcSettingsSection name
'description' => 'This form is registered with a DeclarativeSettingsForm class', // NcSettingsSection description
'doc_url' => '', // NcSettingsSection doc_url for documentation or help page, empty string if not needed
'fields' => [
[
'id' => 'test_ex_app_field_7', // configkey
'title' => 'Multi-selection', // name or label
'description' => 'Select some option setting', // hint
'type' => DeclarativeSettingsTypes::MULTI_SELECT, // select, radio, multi-select
'options' => ['foo', 'bar', 'baz'], // simple options for select, radio, multi-select
'placeholder' => 'Select some multiple options', // input placeholder
'default' => ['foo', 'bar'],
],
[
'id' => 'some_real_setting',
'title' => 'Choose init status check background job interval',
'description' => 'How often AppAPI should check for initialization status',
'type' => DeclarativeSettingsTypes::RADIO, // radio (NcCheckboxRadioSwitch type radio)
'placeholder' => 'Choose init status check background job interval',
'default' => '40m',
'options' => [
[
'name' => 'Each 40 minutes', // NcCheckboxRadioSwitch display name
'value' => '40m' // NcCheckboxRadioSwitch value
],
[
'name' => 'Each 60 minutes',
'value' => '60m'
],
[
'name' => 'Each 120 minutes',
'value' => '120m'
],
[
'name' => 'Each day',
'value' => 60 * 24 . 'm'
],
],
],
[
'id' => 'test_ex_app_field_1', // configkey
'title' => 'Default text field', // label
'description' => 'Set some simple text setting', // hint
'type' => DeclarativeSettingsTypes::TEXT, // text, password, email, tel, url, number
'placeholder' => 'Enter text setting', // placeholder
'default' => 'foo',
],
[
'id' => 'test_ex_app_field_1_1',
'title' => 'Email field',
'description' => 'Set email config',
'type' => DeclarativeSettingsTypes::EMAIL,
'placeholder' => 'Enter email',
'default' => '',
],
[
'id' => 'test_ex_app_field_1_2',
'title' => 'Tel field',
'description' => 'Set tel config',
'type' => DeclarativeSettingsTypes::TEL,
'placeholder' => 'Enter your tel',
'default' => '',
],
[
'id' => 'test_ex_app_field_1_3',
'title' => 'Url (website) field',
'description' => 'Set url config',
'type' => 'url',
'placeholder' => 'Enter url',
'default' => '',
],
[
'id' => 'test_ex_app_field_1_4',
'title' => 'Number field',
'description' => 'Set number config',
'type' => DeclarativeSettingsTypes::NUMBER,
'placeholder' => 'Enter number value',
'default' => 0,
],
[
'id' => 'test_ex_app_field_2',
'title' => 'Password',
'description' => 'Set some secure value setting',
'type' => 'password',
'placeholder' => 'Set secure value',
'default' => '',
],
[
'id' => 'test_ex_app_field_3',
'title' => 'Selection',
'description' => 'Select some option setting',
'type' => DeclarativeSettingsTypes::SELECT, // select, radio, multi-select
'options' => ['foo', 'bar', 'baz'],
'placeholder' => 'Select some option setting',
'default' => 'foo',
],
[
'id' => 'test_ex_app_field_4',
'title' => 'Toggle something',
'description' => 'Select checkbox option setting',
'type' => DeclarativeSettingsTypes::CHECKBOX, // checkbox, multiple-checkbox
'label' => 'Verify something if enabled',
'default' => false,
],
[
'id' => 'test_ex_app_field_5',
'title' => 'Multiple checkbox toggles, describing one setting, checked options are saved as an JSON object {foo: true, bar: false}',
'description' => 'Select checkbox option setting',
'type' => DeclarativeSettingsTypes::MULTI_CHECKBOX, // checkbox, multi-checkbox
'default' => ['foo' => true, 'bar' => true, 'baz' => true],
'options' => [
[
'name' => 'Foo',
'value' => 'foo', // multiple-checkbox configkey
],
[
'name' => 'Bar',
'value' => 'bar',
],
[
'name' => 'Baz',
'value' => 'baz',
],
[
'name' => 'Qux',
'value' => 'qux',
],
],
],
[
'id' => 'test_ex_app_field_6',
'title' => 'Radio toggles, describing one setting like single select',
'description' => 'Select radio option setting',
'type' => DeclarativeSettingsTypes::RADIO, // radio (NcCheckboxRadioSwitch type radio)
'label' => 'Select single toggle',
'default' => 'foo',
'options' => [
[
'name' => 'First radio', // NcCheckboxRadioSwitch display name
'value' => 'foo' // NcCheckboxRadioSwitch value
],
[
'name' => 'Second radio',
'value' => 'bar'
],
[
'name' => 'Third radio',
'value' => 'baz'
],
],
],
],
];
}
}
|