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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Theme\Model\ResourceModel\Design\Config\Scope;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\ScopeTreeProviderInterface;
use Magento\Framework\Data\Collection\EntityFactoryInterface;
use Magento\Theme\Model\Design\Config\MetadataProviderInterface;
use Magento\Theme\Model\Design\Config\ValueProcessor;
/**
* Data collection
*
*/
class Collection extends \Magento\Framework\Data\Collection
{
/**
* @var ScopeTreeProviderInterface
*/
protected $scopeTree;
/**
* @var MetadataProviderInterface
*/
protected $metadataProvider;
/**
* @var ScopeConfigInterface
*/
protected $appConfig;
/**
* @var ValueProcessor
*/
protected $valueProcessor;
/**
* Collection constructor
*
* @param EntityFactoryInterface $entityFactory
* @param ScopeTreeProviderInterface $scopeTree
* @param MetadataProviderInterface $metadataProvider
* @param ScopeConfigInterface $appConfig
* @param ValueProcessor $valueProcessor
*/
public function __construct(
EntityFactoryInterface $entityFactory,
ScopeTreeProviderInterface $scopeTree,
MetadataProviderInterface $metadataProvider,
ScopeConfigInterface $appConfig,
ValueProcessor $valueProcessor
) {
parent::__construct($entityFactory);
$this->scopeTree = $scopeTree;
$this->metadataProvider = $metadataProvider;
$this->appConfig = $appConfig;
$this->valueProcessor = $valueProcessor;
}
/**
* Load data
*
* @param bool $printQuery
* @param bool $logQuery
* @return \Magento\Theme\Model\ResourceModel\Design\Config\Scope\Collection
*
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function loadData($printQuery = false, $logQuery = false)
{
if (!$this->isLoaded()) {
$default = $this->scopeTree->get();
$this->prepareItemData();
foreach ($default['scopes'] as $website) {
$this->prepareItemData($website);
foreach ($website['scopes'] as $group) {
foreach ($group['scopes'] as $store) {
$this->prepareItemData($website, $group, $store);
}
}
}
$this->_setIsLoaded(true);
}
return $this;
}
/**
* Retrieve fields metadata
*
* @param string $scope
* @param int $scopeId
* @return array
*/
protected function getMetadataValues($scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeId = null)
{
$result = [];
foreach ($this->metadataProvider->get() as $itemName => $itemData) {
if (isset($itemData['use_in_grid']) && (boolean)$itemData['use_in_grid']) {
$result[$itemName] = $this->valueProcessor->process(
$this->appConfig->getValue($itemData['path'], $scope, $scopeId),
$scope,
$scopeId,
$itemData
);
}
}
return $result;
}
/**
* Prepare item data depend on scope
*
* @param array $websiteScope
* @param array $groupScope
* @param array $storeScope
*
* @return void
*/
protected function prepareItemData(array $websiteScope = [], array $groupScope = [], array $storeScope = [])
{
$result = [
'store_website_id' => isset($websiteScope['scope_id']) ? $websiteScope['scope_id'] : null,
'store_group_id' => isset($groupScope['scope_id']) ? $groupScope['scope_id'] : null,
'store_id' => isset($storeScope['scope_id']) ? $storeScope['scope_id'] : null,
];
$result = array_merge($result, $this->getScopeData($websiteScope, $groupScope, $storeScope));
$this->_addItem(new \Magento\Framework\DataObject($result));
}
/**
* Retrieve scope data
*
* @param array $websiteScope
* @param array $groupScope
* @param array $storeScope
* @return array
*/
protected function getScopeData(array $websiteScope, array $groupScope, array $storeScope)
{
if (isset($storeScope['scope'])) {
$data = $this->getMetadataValues($storeScope['scope'], $storeScope['scope_id']);
} elseif (isset($groupScope['scope'])) {
$data = $this->getMetadataValues($groupScope['scope'], $groupScope['scope_id']);
} elseif (isset($websiteScope['scope'])) {
$data = $this->getMetadataValues($websiteScope['scope'], $websiteScope['scope_id']);
} else {
$data = $this->getMetadataValues();
}
return $data;
}
}