/
Grid.php
426 lines (379 loc) · 10.5 KB
/
Grid.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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Reports\Block\Adminhtml;
use Magento\Backend\Block\Template\Context;
use Magento\Backend\Helper\Data;
use Magento\Framework\Url\DecoderInterface;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Stdlib\Parameters;
/**
* Backend report grid block
*
* @api
* @author Magento Core Team <core@magentocommerce.com>
* @since 100.0.2
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
class Grid extends \Magento\Backend\Block\Widget\Grid
{
/**
* @var DecoderInterface
*/
private $urlDecoder;
/**
* @var Parameters
*/
private $parameters;
/**
* Should Store Switcher block be visible
*
* @var bool
*/
protected $_storeSwitcherVisibility = true;
/**
* Should Date Filter block be visible
*
* @var bool
*/
protected $_dateFilterVisibility = true;
/**
* Filters array
*
* @var array
*/
protected $_filters = [];
/**
* Default filters values
*
* @var array
*/
protected $_defaultFilters = ['report_from' => '', 'report_to' => '', 'report_period' => 'day'];
/**
* Sub-report rows count
*
* @var int
*/
protected $_subReportSize = 5;
/**
* Errors messages aggregated array
*
* @var array
*/
protected $_errors = [];
/**
* Block template file name
*
* @var string
*/
protected $_template = 'Magento_Reports::grid.phtml';
/**
* Filter values array
*
* @var array
*/
protected $_filterValues;
/**
* @param Context $context
* @param Data $backendHelper
* @param array $data
* @param DecoderInterface|null $urlDecoder
* @param Parameters|null $parameters
*/
public function __construct(
Context $context,
Data $backendHelper,
array $data = [],
DecoderInterface $urlDecoder = null,
Parameters $parameters = null
) {
$this->urlDecoder = $urlDecoder ?? ObjectManager::getInstance()->get(
DecoderInterface::class
);
$this->parameters = $parameters ?? ObjectManager::getInstance()->get(
Parameters::class
);
parent::__construct($context, $backendHelper, $data);
}
/**
* Apply sorting and filtering to collection
*
* @return $this
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
protected function _prepareCollection()
{
$filter = $this->getParam($this->getVarNameFilter(), null);
if (null === $filter) {
$filter = $this->_defaultFilter;
}
if (is_string($filter)) {
// this is a replacement for base64_decode()
$filter = $this->urlDecoder->decode($filter);
// this is a replacement for parse_str()
$this->parameters->fromString(urldecode($filter));
$data = $this->parameters->toArray();
if (!isset($data['report_from'])) {
// getting all reports from 2001 year
$date = (new \DateTime())->setTimestamp(mktime(0, 0, 0, 1, 1, 2001));
$data['report_from'] = $this->_localeDate->formatDateTime(
$date,
\IntlDateFormatter::SHORT,
\IntlDateFormatter::NONE
);
}
if (!isset($data['report_to'])) {
// getting all reports from 2001 year
$date = new \DateTime();
$data['report_to'] = $this->_localeDate->formatDateTime(
$date,
\IntlDateFormatter::SHORT,
\IntlDateFormatter::NONE
);
}
$this->_setFilterValues($data);
} elseif ($filter && is_array($filter)) {
$this->_setFilterValues($filter);
} elseif (0 !== count($this->_defaultFilter)) {
$this->_setFilterValues($this->_defaultFilter);
}
/** @var $collection \Magento\Reports\Model\ResourceModel\Report\Collection */
$collection = $this->getCollection();
if ($collection) {
$collection->setPeriod($this->getFilter('report_period'));
if ($this->getFilter('report_from') && $this->getFilter('report_to')) {
/**
* Validate from and to date
*/
try {
$from = $this->_localeDate->date($this->getFilter('report_from'), null, true, false);
$to = $this->_localeDate->date($this->getFilter('report_to'), null, true, false);
$collection->setInterval($from, $to);
} catch (\Exception $e) {
$this->_errors[] = __('Invalid date specified');
}
}
$collection->setStoreIds($this->_getAllowedStoreIds());
if ($this->getSubReportSize() !== null) {
$collection->setPageSize($this->getSubReportSize());
}
$this->_eventManager->dispatch(
'adminhtml_widget_grid_filter_collection',
['collection' => $this->getCollection(), 'filter_values' => $this->_filterValues]
);
}
return $this;
}
/**
* Get allowed stores
*
* @return array|\int[]
*/
protected function _getAllowedStoreIds()
{
/**
* Getting and saving store ids for website & group
*/
$storeIds = [];
if ($this->getRequest()->getParam('store')) {
$storeIds = [$this->getParam('store')];
} elseif ($this->getRequest()->getParam('website')) {
$storeIds = $this->_storeManager->getWebsite($this->getRequest()->getParam('website'))->getStoreIds();
} elseif ($this->getRequest()->getParam('group')) {
$storeIds = $storeIds = $this->_storeManager->getGroup(
$this->getRequest()->getParam('group')
)->getStoreIds();
}
// By default storeIds array contains only allowed stores
$allowedStoreIds = array_keys($this->_storeManager->getStores());
// And then array_intersect with post data for prevent unauthorized stores reports
$storeIds = array_intersect($allowedStoreIds, $storeIds);
// If selected all websites or unauthorized stores use only allowed
if (empty($storeIds)) {
$storeIds = $allowedStoreIds;
}
// reset array keys
$storeIds = array_values($storeIds);
return $storeIds;
}
/**
* Set filter values
*
* @param array $data
* @return $this
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
protected function _setFilterValues($data)
{
foreach ($data as $name => $value) {
$this->setFilter($name, $data[$name]);
}
return $this;
}
/**
* Set visibility of store switcher
*
* @param bool $visible
* @codeCoverageIgnore
* @return void
*/
public function setStoreSwitcherVisibility($visible = true)
{
$this->_storeSwitcherVisibility = $visible;
}
/**
* Return visibility of store switcher
* @codeCoverageIgnore
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getStoreSwitcherVisibility()
{
return $this->_storeSwitcherVisibility;
}
/**
* Return store switcher html
* @codeCoverageIgnore
*
* @return string
*/
public function getStoreSwitcherHtml()
{
return $this->getChildHtml('store_switcher');
}
/**
* Set visibility of date filter
*
* @param bool $visible
* @return void
* @codeCoverageIgnore
*/
public function setDateFilterVisibility($visible = true)
{
$this->_dateFilterVisibility = $visible;
}
/**
* Return visibility of date filter
* @codeCoverageIgnore
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getDateFilterVisibility()
{
return $this->_dateFilterVisibility;
}
/**
* Return date filter html
* @codeCoverageIgnore
*
* @return string
*/
public function getDateFilterHtml()
{
return $this->getChildHtml('date_filter');
}
/**
* Get periods
*
* @return mixed
*/
public function getPeriods()
{
return $this->getCollection()->getPeriods();
}
/**
* Get date format according the locale
*
* @return string
*/
public function getDateFormat()
{
return $this->_localeDate->getDateFormat(\IntlDateFormatter::SHORT);
}
/**
* Return refresh button html
* @codeCoverageIgnore
*
* @return string
*/
public function getRefreshButtonHtml()
{
return $this->getChildHtml('refresh_button');
}
/**
* Set filter
*
* @param string $name
* @param string $value
* @return void
* @codeCoverageIgnore
*/
public function setFilter($name, $value)
{
if ($name) {
$this->_filters[$name] = $value;
}
}
/**
* Get filter by key
*
* @param string $name
* @return string
*/
public function getFilter($name)
{
if (isset($this->_filters[$name])) {
return $this->_filters[$name];
} else {
return $this->getRequest()->getParam($name) ? $this->escapeHtml($this->getRequest()->getParam($name)) : '';
}
}
/**
* Set sub-report rows count
*
* @param int $size
* @return void
* @codeCoverageIgnore
*/
public function setSubReportSize($size)
{
$this->_subReportSize = $size;
}
/**
* Return sub-report rows count
* @codeCoverageIgnore
*
* @return int
*/
public function getSubReportSize()
{
return $this->_subReportSize;
}
/**
* Retrieve errors
*
* @return array
* @codeCoverageIgnore
*/
public function getErrors()
{
return $this->_errors;
}
/**
* Prepare grid filter buttons
*
* @return void
*/
protected function _prepareFilterButtons()
{
$this->addChild(
'refresh_button',
\Magento\Backend\Block\Widget\Button::class,
['label' => __('Refresh'), 'onclick' => "{$this->getJsObjectName()}.doFilter();", 'class' => 'task']
);
}
}