ElementBuilderFactory.php
9.74 KB
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
<?php
namespace YahnisElsts\AdminMenuEditor\Customizable\Builders;
use YahnisElsts\AdminMenuEditor\Customizable\Controls;
use YahnisElsts\AdminMenuEditor\Customizable\Controls\UiElement;
use YahnisElsts\AdminMenuEditor\Customizable\Settings;
use YahnisElsts\AdminMenuEditor\Customizable\Settings\Setting;
use YahnisElsts\AdminMenuEditor\Customizable\Storage\AbstractSettingsDictionary;
use YahnisElsts\AdminMenuEditor\ProCustomizable\Controls\BackgroundPositionSelector;
use YahnisElsts\AdminMenuEditor\ProCustomizable\Controls\BackgroundRepeat;
use YahnisElsts\AdminMenuEditor\ProCustomizable\Controls\BoxDimensions;
use YahnisElsts\AdminMenuEditor\ProCustomizable\Controls\FontStylePicker;
class ElementBuilderFactory {
/**
* @var AbstractSettingsDictionary|null
*/
protected $settingLookup = null;
public function __construct(AbstractSettingsDictionary $settingLookup = null) {
$this->settingLookup = $settingLookup;
}
/**
* @return \YahnisElsts\AdminMenuEditor\Customizable\Storage\AbstractSettingsDictionary|null
*/
public function getSettingDictionary() {
return $this->settingLookup;
}
/**
* @param \YahnisElsts\AdminMenuEditor\Customizable\Controls\Container|ContainerBuilder ...$containers
* @return InterfaceBuilder
*/
public function structure(...$containers) {
$builder = new InterfaceBuilder();
foreach ($containers as $container) {
$builder->add($container);
}
return $builder;
}
/**
*
* @param string $title
* @param ElementBuilder|UiElement|ElementBuilder[]|UiElement[] ...$children
* @return SectionBuilder
*/
public function section($title = '', ...$children) {
return new SectionBuilder($title, $children);
}
/**
* @param string $title
* @param ElementBuilder|UiElement ...$children
* @return GroupBuilder
*/
public function group($title = '', ...$children) {
return new GroupBuilder($title, $children);
}
/**
* @param string|Setting|null $idOrSetting
* @return TextBoxBuilder
*/
public function textBox($idOrSetting = '') {
return new TextBoxBuilder($this->findSettings($idOrSetting));
}
/**
* @param string|Setting|null $idOrSetting
* @return ControlBuilder<\YahnisElsts\AdminMenuEditor\Customizable\Controls\CheckBox>
*/
public function checkBox($idOrSetting = null) {
return $this->initControlBuilder(Controls\CheckBox::class, $idOrSetting);
}
/**
* @param class-string<\YahnisElsts\AdminMenuEditor\Customizable\Controls\Control> $controlClass
* @param string|Setting|array<string|Setting> $idOrSetting
*/
protected function initControlBuilder($controlClass, $idOrSetting) {
return new ControlBuilder($controlClass, $this->findSettings($idOrSetting));
}
/**
* @param Setting|null $idOrSetting
* @return TextareaBuilder
*/
public function textArea($idOrSetting = null) {
return new TextareaBuilder($this->findSettings($idOrSetting), []);
}
/**
* @param string $rawHtml
* @return StaticHtmlBuilder
*/
public function html($rawHtml) {
return new StaticHtmlBuilder($rawHtml);
}
/**
* @param Setting|null|string $idOrSetting
* @return EditorBuilder
*/
public function editor($idOrSetting = null) {
return new EditorBuilder($this->findSettings($idOrSetting));
}
/**
* @param Setting|null|string $idOrSetting
* @return ControlBuilder<\YahnisElsts\AdminMenuEditor\Customizable\Controls\RadioGroup>
*/
public function radioGroup($idOrSetting = null) {
return new RadioGroupBuilder($this->findSettings($idOrSetting));
}
/**
* @param Setting|null|string $idOrSetting
* @return ControlBuilder<\YahnisElsts\AdminMenuEditor\Customizable\Controls\SelectBox>
*/
public function select($idOrSetting = null) {
return $this->initControlBuilder(Controls\SelectBox::class, $idOrSetting);
}
/**
* @param Setting|null|string $idOrSetting
* @return ControlBuilder<\YahnisElsts\AdminMenuEditor\Customizable\Controls\ColorPicker>
*/
public function colorPicker($idOrSetting = null) {
return $this->initControlBuilder(Controls\ColorPicker::class, $idOrSetting);
}
public function imageSelector($idOrSetting = null) {
return $this->initControlBuilder(Controls\ImageSelector::class, $idOrSetting);
}
public function codeEditor($idOrSetting = null) {
return new CodeEditorBuilder($this->findSettings($idOrSetting));
}
public function backgroundPosition($idOrSetting = null) {
return $this->initControlBuilder(
BackgroundPositionSelector::class,
$idOrSetting
);
}
public function backgroundRepeat($idOrSetting = null) {
return $this->initControlBuilder(BackgroundRepeat::class, $idOrSetting);
}
public function backgroundSize($idOrSetting = null) {
return $this->radioGroup($idOrSetting)
->label('Image size')
->params(['descriptionsAsTooltips' => true]);
}
public function fontStyle($idOrSetting = null) {
return $this->initControlBuilder(FontStylePicker::class, $idOrSetting);
}
public function toggleCheckBox($idOrSetting = null) {
return new ToggleCheckBoxBuilder($this->findSettings($idOrSetting));
}
/**
* Create a "Save Changes" button. It uses the default submit button settings.
*
* @param boolean $wrapInParagraph
* @return \YahnisElsts\AdminMenuEditor\Customizable\Builders\StaticHtmlBuilder
*/
public function saveButton($wrapInParagraph = false) {
return $this->html(
get_submit_button(null, 'primary', 'submit', $wrapInParagraph)
);
}
public function number($idOrSetting = null) {
return new NumberInputBuilder($this->findSettings($idOrSetting));
}
public function boxDimensions($idOrSetting = null) {
return $this->initControlBuilder(BoxDimensions::class, $idOrSetting);
}
/**
* Automatically choose a suitable control or container for the given setting.
*
* @param \YahnisElsts\AdminMenuEditor\Customizable\Settings\AbstractSetting|string $idOrSetting
* @return BaseElementBuilder
*/
public function auto($idOrSetting) {
list($setting) = $this->findSettings($idOrSetting);
if ( $setting instanceof Settings\EnumSetting ) {
return $this->radioGroup($setting);
} else if ( $setting instanceof Settings\BooleanSetting ) {
return $this->toggleCheckBox($setting)->onValue(true)->offValue(false);
} else if ( $setting instanceof Settings\ImageSetting ) {
return $this->imageSelector($setting);
} else if ( $setting instanceof Settings\NumericSetting ) {
return $this->number($setting);
} else if ( $setting instanceof Settings\PredefinedSet ) {
return $this->autoSection($setting);
} else if ( $setting instanceof Settings\AbstractSetting ) {
switch ($setting->getDataType()) {
case 'color':
return $this->colorPicker($setting);
case 'url':
return $this->textBox($setting)->type('url')->code();
default:
return $this->textBox($setting);
}
} else {
if ( empty($setting) ) {
throw new \InvalidArgumentException("Setting not found: " . $idOrSetting);
} else {
throw new \InvalidArgumentException("Unsupported setting type: " . get_class($setting));
}
}
}
/**
* Create a section from the specified setting(s). Supports predefined sets of settings
* as well as regular structs. You could even pass a single setting, but that's not very useful.
*
* @param $idOrSetting
* @param string|null $title
* @param string $role
* @return SectionBuilder
*/
public function autoSection($idOrSetting, $title = null, $role = Controls\Section::CONTENT_ROLE) {
$settings = $this->findSettings($idOrSetting);
if ( empty($settings) && is_string($idOrSetting) ) {
$predefinedSet = $this->settingLookup->getPredefinedSet($idOrSetting);
if ( $predefinedSet !== null ) {
$settings = [$predefinedSet];
}
}
$firstSetting = reset($settings);
if ( $firstSetting instanceof Settings\PredefinedSet ) {
$controls = $firstSetting->createControls($this);
return $this->section(
$title ?: $firstSetting->getLabel(),
...$controls
)->params(['preferredRole' => $role]);
}
if ( !empty($settings) ) {
$section = $this->section($title)->params(['preferredRole' => $role]);
foreach ($settings as $setting) {
$section->add($this->auto($setting));
}
return $section;
} else {
throw new \InvalidArgumentException("Setting not found: " . $idOrSetting);
}
}
/**
* @param string $title
* @param ElementBuilder|UiElement|ElementBuilder[]|UiElement[] ...$children
* @return \YahnisElsts\AdminMenuEditor\Customizable\Builders\SectionBuilder
*/
public function contentSection($title = '', ...$children) {
return $this->section($title, $children)
->params(['preferredRole' => Controls\Section::CONTENT_ROLE]);
}
/**
* @template T of \YahnisElsts\AdminMenuEditor\Customizable\Controls\Control
* @param class-string<T> $controlClass
* @param Setting|null|string $idOrSetting
* @return ControlBuilder<T>
*/
public function control($controlClass, $idOrSetting = null) {
return $this->initControlBuilder($controlClass, $idOrSetting);
}
/**
* @param Setting|string|null|array<string|Setting> $idOrSetting
* @return Setting[]
*/
protected function findSettings($idOrSetting) {
if ( $idOrSetting instanceof Settings\AbstractSetting ) {
return [$idOrSetting];
} else if ( is_string($idOrSetting) ) {
if ( isset($this->settingLookup) ) {
return [$this->settingLookup->getSetting($idOrSetting)];
} else {
throw new \InvalidArgumentException(sprintf(
'Cannot find a setting "%s" because no setting lookup was provided.',
$idOrSetting
));
}
} else if ( $idOrSetting === null ) {
return [];
} else if ( is_array($idOrSetting) ) {
$settings = [];
foreach ($idOrSetting as $key => $setting) {
$found = $this->findSettings($setting);
$settings[$key] = !empty($found) ? reset($found) : null;
}
return $settings;
}
throw new \InvalidArgumentException(sprintf(
'Invalid setting query (type: "%s"). Input must be a Setting, a string, or NULL.',
gettype($idOrSetting)
));
}
}