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
225
226
227
228
229
230
231
232
|
<?php
declare(strict_types=1);
/**
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.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\Dashboard\Model;
use JsonSerializable;
/**
* Interface WidgetSetting
*
* Each setting that can be edited by a user should be defined in a
* WidgetSetting.
*
* When using this framework, the settings interface is generated by the
* Dashboard app.
*
* Each WidgetSetting must be generated and declared in the WidgetTemplate
* during the setup of the widget in the IDashboardWidget using addSetting().
*
* @see IDashboardWidget::getWidgetTemplate
* @see WidgetTemplate::addSetting
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
final class WidgetSetting implements JsonSerializable {
public const TYPE_INPUT = 'input';
public const TYPE_CHECKBOX = 'checkbox';
/** @var string */
private $name = '';
/** @var string */
private $title = '';
/** @var string */
private $type = '';
/** @var string */
private $placeholder = '';
/** @var string */
private $default = '';
/**
* WidgetSetting constructor.
*
* @since 15.0.0
*
* @param string $type
*/
public function __construct(string $type = '') {
$this->type = $type;
}
/**
* Set the name of the setting (full string, no space)
*
* @since 15.0.0
*
* @param string $name
*
* @return WidgetSetting
*/
public function setName(string $name): WidgetSetting {
$this->name = $name;
return $this;
}
/**
* Get the name of the setting
*
* @since 15.0.0
*
* @return string
*/
public function getName(): string {
return $this->name;
}
/**
* Set the title/display name of the setting.
*
* @since 15.0.0
*
* @param string $title
*
* @return WidgetSetting
*/
public function setTitle(string $title): WidgetSetting {
$this->title = $title;
return $this;
}
/**
* Get the title of the setting
*
* @since 15.0.0
*
* @return string
*/
public function getTitle(): string {
return $this->title;
}
/**
* Set the type of the setting (input, checkbox, ...)
*
* @since 15.0.0
*
* @param string $type
*
* @return WidgetSetting
*/
public function setType(string $type): WidgetSetting {
$this->type = $type;
return $this;
}
/**
* Get the type of the setting.
*
* @since 15.0.0
*
* @return string
*/
public function getType(): string {
return $this->type;
}
/**
* Set the placeholder (in case of type=input)
*
* @since 15.0.0
*
* @param string $text
*
* @return WidgetSetting
*/
public function setPlaceholder(string $text): WidgetSetting {
$this->placeholder = $text;
return $this;
}
/**
* Get the placeholder.
*
* @since 15.0.0
*
* @return string
*/
public function getPlaceholder(): string {
return $this->placeholder;
}
/**
* Set the default value of the setting.
*
* @since 15.0.0
*
* @param string $value
*
* @return WidgetSetting
*/
public function setDefault(string $value): WidgetSetting {
$this->default = $value;
return $this;
}
/**
* Get the default value.
*
* @since 15.0.0
*
* @return string
*/
public function getDefault(): string {
return $this->default;
}
/**
* @since 15.0.0
*
* @return array
*/
public function jsonSerialize() {
return [
'name' => $this->getName(),
'title' => $this->getTitle(),
'type' => $this->getTitle(),
'default' => $this->getDefault(),
'placeholder' => $this->getPlaceholder()
];
}
}
|
