-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathReportContainer.php
513 lines (410 loc) · 14.8 KB
/
ReportContainer.php
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
<?php namespace Backend\Widgets;
use File;
use Lang;
use Flash;
use Request;
use BackendAuth;
use Backend\Classes\WidgetBase;
use Backend\Classes\WidgetManager;
use Backend\Models\UserPreference;
use System\Models\Parameter as SystemParameters;
use ApplicationException;
/**
* Report Container Widget
* Creates an area hosting report widgets.
*
* @package winter\wn-backend-module
* @author Alexey Bobkov, Samuel Georges
*/
class ReportContainer extends WidgetBase
{
//
// Configurable properties
//
/**
* @var string The unique report context name
* Defines the context where the container is used.
* Widget settings are saved in a specific context. This allows to
* have multiple report containers on different pages that have
* different widgets and widget settings. Context names can contain
* only Latin letters.
*/
public $context = 'dashboard';
/**
* @var string Determines whether widgets could be added and deleted.
*/
public $canAddAndDelete = true;
/**
* @var array A list of default widgets to load.
* This structure could be defined in the widget configuration file (for example config_report_container.yaml).
* Example YAML structure:
*
* defaultWidgets:
* trafficOverview:
* class: Winter\GoogleAnalytics\ReportWidgets\TrafficOverview
* sortOrder: 1
* configuration:
* title: 'Traffic overview'
* ocWidgetWidth: 12
*/
public $defaultWidgets = [];
//
// Object properties
//
/**
* @inheritDoc
*/
protected $defaultAlias = 'reportContainer';
/**
* @var array Collection of all report widgets used by this container.
*/
protected $reportWidgets = [];
/**
* @var boolean Determines if report widgets have been created.
*/
protected $reportsDefined = false;
/**
* Constructor.
*/
public function __construct($controller, $configuration = null)
{
if (!$configuration) {
$configuration = 'config_report_container.yaml';
}
if (is_string($configuration)) {
$path = $controller->getConfigPath($configuration);
if (File::isFile($path)) {
$configuration = $this->makeConfig($path);
}
else {
$configuration = [];
}
}
parent::__construct($controller, $configuration);
$this->fillFromConfig();
$this->bindToController();
}
/**
* Ensure report widgets are registered so they can also be bound to
* the controller this allows their AJAX features to operate.
* @return void
*/
public function bindToController()
{
$this->defineReportWidgets();
parent::bindToController();
}
/**
* Renders this widget along with its collection of report widgets.
*/
public function render()
{
$this->defineReportWidgets();
$this->vars['widgets'] = $this->reportWidgets;
return $this->makePartial('container');
}
/**
* @inheritDoc
*/
protected function loadAssets()
{
$this->addCss('css/reportcontainer.css', 'core');
$this->addJs('vendor/isotope/jquery.isotope.min.js', 'core');
$this->addJs('js/reportcontainer.js', 'core');
}
//
// Event handlers
//
public function onResetWidgets()
{
$this->resetWidgets();
$this->vars['widgets'] = $this->reportWidgets;
Flash::success(Lang::get('backend::lang.dashboard.reset_layout_success'));
return ['#'.$this->getId('container-list') => $this->makePartial('widget_list')];
}
public function onMakeLayoutDefault()
{
if (!BackendAuth::getUser()->hasAccess('backend.manage_default_dashboard')) {
throw new ApplicationException("You do not have permission to do that.");
}
$widgets = $this->getWidgetsFromUserPreferences();
SystemParameters::set($this->getSystemParametersKey(), $widgets);
Flash::success(Lang::get('backend::lang.dashboard.make_default_success'));
}
public function onUpdateWidget()
{
$alias = Request::input('alias');
$widget = $this->findWidgetByAlias($alias);
$widget->setProperties(json_decode(Request::input('fields'), true));
$this->saveWidgetProperties($alias, $widget->getProperties());
return [
'#'.$alias => $widget->render()
];
}
public function onRemoveWidget()
{
$alias = Request::input('alias');
$this->removeWidget($alias);
}
public function onLoadAddPopup()
{
$sizes = [];
for ($i = 1; $i <= 12; $i++) {
$sizes[$i] = $i < 12 ? $i : $i.' (' . Lang::get('backend::lang.dashboard.full_width') . ')';
}
$this->vars['sizes'] = $sizes;
$this->vars['widgets'] = WidgetManager::instance()->listReportWidgets();
return $this->makePartial('new_widget_popup');
}
public function onAddWidget()
{
$className = trim(Request::input('className'));
$size = trim(Request::input('size'));
if (!$className) {
throw new ApplicationException('Please select a widget to add.');
}
if (!class_exists($className)) {
throw new ApplicationException('The selected class doesn\'t exist.');
}
$widget = new $className($this->controller);
if (!($widget instanceof \Backend\Classes\ReportWidgetBase)) {
throw new ApplicationException('The selected class is not a report widget.');
}
$widgetInfo = $this->addWidget($widget, $size);
return [
'@#'.$this->getId('container-list') => $this->makePartial('widget', [
'widget' => $widget,
'widgetAlias' => $widgetInfo['alias'],
'sortOrder' => $widgetInfo['sortOrder']
])
];
}
public function addWidget($widget, $size)
{
if (!$this->canAddAndDelete) {
throw new ApplicationException('Access denied.');
}
$widgets = $this->getWidgetsFromUserPreferences();
$num = count($widgets);
do {
$num++;
$alias = 'report_container_'.$this->context.'_'.$num;
}
while (array_key_exists($alias, $widgets));
// Ensure that the widget's alias is correctly set for this request
$widget->alias = $alias;
$sortOrder = 0;
foreach ($widgets as $widgetInfo) {
$sortOrder = max($sortOrder, $widgetInfo['sortOrder']);
}
$sortOrder++;
$widget->setProperty('ocWidgetWidth', $size);
$widgets[$alias] = [
'class' => get_class($widget),
'configuration' => $widget->getProperties(),
'sortOrder' => $sortOrder
];
$this->setWidgetsToUserPreferences($widgets);
return [
'alias' => $alias,
'sortOrder' => $widgets[$alias]['sortOrder']
];
}
public function onSetWidgetOrders()
{
$aliases = trim(Request::input('aliases'));
$orders = trim(Request::input('orders'));
if (!$aliases) {
throw new ApplicationException('Invalid aliases string.');
}
if (!$orders) {
throw new ApplicationException('Invalid orders string.');
}
$aliases = explode(',', $aliases);
$orders = explode(',', $orders);
if (count($aliases) != count($orders)) {
throw new ApplicationException('Invalid data posted.');
}
$widgets = $this->getWidgetsFromUserPreferences();
foreach ($aliases as $index => $alias) {
if (isset($widgets[$alias])) {
$widgets[$alias]['sortOrder'] = $orders[$index];
}
}
$this->setWidgetsToUserPreferences($widgets);
}
//
// Methods for internal use
//
/**
* Registers the report widgets that will be included in this container.
* The chosen widgets are based on the user preferences.
*/
protected function defineReportWidgets()
{
if ($this->reportsDefined) {
return;
}
$result = [];
$widgets = $this->getWidgetsFromUserPreferences();
foreach ($widgets as $alias => $widgetInfo) {
if ($widget = $this->makeReportWidget($alias, $widgetInfo)) {
$result[$alias] = $widget;
}
}
uasort($result, function ($a, $b) {
return $a['sortOrder'] - $b['sortOrder'];
});
$this->reportWidgets = $result;
$this->reportsDefined = true;
}
/**
* Makes a single report widget object, returned array index:
* - widget: The widget object (Backend\Classes\ReportWidgetBase)
* - sortOrder: The current sort order
*
* @param string $alias
* @param array $widgetInfo
* @return array
*/
protected function makeReportWidget($alias, $widgetInfo)
{
$configuration = $widgetInfo['configuration'];
$configuration['alias'] = $alias;
$className = $widgetInfo['class'];
$availableReportWidgets = array_keys(WidgetManager::instance()->listReportWidgets());
if (!class_exists($className) || !in_array($className, $availableReportWidgets)) {
return;
}
$widget = new $className($this->controller, $configuration);
$widget->bindToController();
return ['widget' => $widget, 'sortOrder' => $widgetInfo['sortOrder']];
}
protected function resetWidgets()
{
$this->resetWidgetsUserPreferences();
$this->reportsDefined = false;
$this->defineReportWidgets();
}
protected function removeWidget($alias)
{
if (!$this->canAddAndDelete) {
throw new ApplicationException('Access denied.');
}
$widgets = $this->getWidgetsFromUserPreferences();
if (isset($widgets[$alias])) {
unset($widgets[$alias]);
}
$this->setWidgetsToUserPreferences($widgets);
}
protected function findWidgetByAlias($alias)
{
$this->defineReportWidgets();
$widgets = $this->reportWidgets;
if (!isset($widgets[$alias])) {
throw new ApplicationException('The specified widget is not found.');
}
return $widgets[$alias]['widget'];
}
protected function getWidgetPropertyConfig($widget)
{
$properties = $widget->defineProperties();
$property = [
'property' => 'ocWidgetWidth',
'title' => Lang::get('backend::lang.dashboard.widget_columns_label', ['columns' => '(1-12)']),
'description' => Lang::get('backend::lang.dashboard.widget_columns_description'),
'type' => 'dropdown',
'validationPattern' => '^[0-9]+$',
'validationMessage' => Lang::get('backend::lang.dashboard.widget_columns_error'),
'options' => [
1 => '1 ' . Lang::choice('backend::lang.dashboard.columns', 1),
2 => '2 ' . Lang::choice('backend::lang.dashboard.columns', 2),
3 => '3 ' . Lang::choice('backend::lang.dashboard.columns', 3),
4 => '4 ' . Lang::choice('backend::lang.dashboard.columns', 4),
5 => '5 ' . Lang::choice('backend::lang.dashboard.columns', 5),
6 => '6 ' . Lang::choice('backend::lang.dashboard.columns', 6),
7 => '7 ' . Lang::choice('backend::lang.dashboard.columns', 7),
8 => '8 ' . Lang::choice('backend::lang.dashboard.columns', 8),
9 => '9 ' . Lang::choice('backend::lang.dashboard.columns', 9),
10 => '10 ' . Lang::choice('backend::lang.dashboard.columns', 10),
11 => '11 ' . Lang::choice('backend::lang.dashboard.columns', 11),
12 => '12 ' . Lang::choice('backend::lang.dashboard.columns', 12)
]
];
$result[] = $property;
$property = [
'property' => 'ocWidgetNewRow',
'title' => Lang::get('backend::lang.dashboard.widget_new_row_label'),
'description' => Lang::get('backend::lang.dashboard.widget_new_row_description'),
'type' => 'checkbox'
];
$result[] = $property;
foreach ($properties as $name => $params) {
$property = [
'property' => $name,
'title' => isset($params['title']) ? Lang::get($params['title']) : $name,
'type' => $params['type'] ?? 'string'
];
foreach ($params as $name => $value) {
if (isset($property[$name])) {
continue;
}
$property[$name] = !is_array($value) ? Lang::get($value) : $value;
}
$result[] = $property;
}
return json_encode($result);
}
protected function getWidgetPropertyValues($widget)
{
$result = [];
$properties = $widget->defineProperties();
foreach ($properties as $name => $params) {
$value = $widget->property($name);
if (is_string($value)) {
$value = Lang::get($value);
}
$result[$name] = $value;
}
$result['ocWidgetWidth'] = $widget->property('ocWidgetWidth');
$result['ocWidgetNewRow'] = $widget->property('ocWidgetNewRow');
return json_encode($result);
}
//
// User and system value storage
//
protected function getWidgetsFromUserPreferences()
{
$defaultWidgets = SystemParameters::get($this->getSystemParametersKey(), $this->defaultWidgets);
$widgets = UserPreference::forUser()
->get($this->getUserPreferencesKey(), $defaultWidgets);
if (!is_array($widgets)) {
return [];
}
return $widgets;
}
protected function setWidgetsToUserPreferences($widgets)
{
UserPreference::forUser()->set($this->getUserPreferencesKey(), $widgets);
}
protected function resetWidgetsUserPreferences()
{
UserPreference::forUser()->reset($this->getUserPreferencesKey());
}
protected function saveWidgetProperties($alias, $properties)
{
$widgets = $this->getWidgetsFromUserPreferences();
if (isset($widgets[$alias])) {
$widgets[$alias]['configuration'] = $properties;
$this->setWidgetsToUserPreferences($widgets);
}
}
protected function getUserPreferencesKey()
{
return 'backend::reportwidgets.'.$this->context;
}
protected function getSystemParametersKey()
{
return 'backend::reportwidgets.default.'.$this->context;
}
}