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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order;
use Magento\Framework\Exception\LocalizedException;
/**
* Order configuration model
*
* @api
* @since 100.0.2
*/
class Config
{
/**
* @var \Magento\Sales\Model\ResourceModel\Order\Status\Collection
*/
protected $collection;
/**
* Statuses per state array
*
* @var array
*/
protected $stateStatuses;
/**
* @var array
*/
private $statuses;
/**
* @var Status
*/
protected $orderStatusFactory;
/**
* @var \Magento\Sales\Model\ResourceModel\Order\Status\CollectionFactory
*/
protected $orderStatusCollectionFactory;
/**
* @var \Magento\Framework\App\State
*/
protected $state;
/**
* @var array
*/
protected $maskStatusesMapping = [
\Magento\Framework\App\Area::AREA_FRONTEND => [
\Magento\Sales\Model\Order::STATUS_FRAUD => \Magento\Sales\Model\Order::STATE_PROCESSING,
\Magento\Sales\Model\Order::STATE_PAYMENT_REVIEW => \Magento\Sales\Model\Order::STATE_PROCESSING
]
];
/**
* Constructor
*
* @param \Magento\Sales\Model\Order\StatusFactory $orderStatusFactory
* @param \Magento\Sales\Model\ResourceModel\Order\Status\CollectionFactory $orderStatusCollectionFactory
* @param \Magento\Framework\App\State $state
*/
public function __construct(
\Magento\Sales\Model\Order\StatusFactory $orderStatusFactory,
\Magento\Sales\Model\ResourceModel\Order\Status\CollectionFactory $orderStatusCollectionFactory,
\Magento\Framework\App\State $state
) {
$this->orderStatusFactory = $orderStatusFactory;
$this->orderStatusCollectionFactory = $orderStatusCollectionFactory;
$this->state = $state;
}
/**
* Get collection.
*
* @return \Magento\Sales\Model\ResourceModel\Order\Status\Collection
*/
protected function _getCollection()
{
if ($this->collection == null) {
$this->collection = $this->orderStatusCollectionFactory->create()->joinStates();
}
return $this->collection;
}
/**
* Get state.
*
* @param string $state
* @return Status
*/
protected function _getState($state)
{
foreach ($this->_getCollection() as $item) {
if ($item->getData('state') == $state) {
return $item;
}
}
return null;
}
/**
* Retrieve default status for state
*
* @param string $state
* @return string|null
*/
public function getStateDefaultStatus($state): ?string
{
$status = false;
$stateNode = $this->_getState($state);
if ($stateNode) {
$status = $this->orderStatusFactory->create()->loadDefaultByState($state);
$status = $status->getStatus();
}
return $status;
}
/**
* Get status label for a specified area
*
* @param string|null $code
* @param string $area
* @return string|null
*/
private function getStatusLabelForArea(?string $code, string $area): ?string
{
$code = $this->maskStatusForArea($area, $code);
$status = $this->orderStatusFactory->create()->load($code);
if ($area === 'adminhtml') {
return $status->getLabel();
}
return $status->getStoreLabel();
}
/**
* Retrieve status label for detected area
*
* @param string|null $code
* @return string|null
* @throws LocalizedException
*/
public function getStatusLabel($code)
{
$area = $this->state->getAreaCode() ?: \Magento\Framework\App\Area::AREA_FRONTEND;
return $this->getStatusLabelForArea($code, $area);
}
/**
* Retrieve status label for area
*
* @param string|null $code
* @return string|null
* @since 102.0.1
*/
public function getStatusFrontendLabel(?string $code): ?string
{
return $this->getStatusLabelForArea($code, \Magento\Framework\App\Area::AREA_FRONTEND);
}
/**
* Mask status for order for specified area
*
* @param string $area
* @param string $code
* @return string
*/
protected function maskStatusForArea($area, $code)
{
if (isset($this->maskStatusesMapping[$area][$code])) {
return $this->maskStatusesMapping[$area][$code];
}
return $code;
}
/**
* State label getter
*
* @param string $state
* @return \Magento\Framework\Phrase|string
*/
public function getStateLabel($state)
{
if ($stateItem = $this->_getState($state)) {
$label = $stateItem->getData('label');
return __($label);
}
return $state;
}
/**
* Retrieve all statuses
*
* @return array
*/
public function getStatuses()
{
$statuses = $this->orderStatusCollectionFactory->create()->toOptionHash();
return $statuses;
}
/**
* Order states getter
*
* @return array
*/
public function getStates()
{
$states = [];
foreach ($this->_getCollection() as $item) {
if ($item->getState()) {
$states[$item->getState()] = __($item->getData('label'));
}
}
return $states;
}
/**
* Retrieve statuses available for state
* Get all possible statuses, or for specified state, or specified states array
* Add labels by default. Return plain array of statuses, if no labels.
*
* @param mixed $state
* @param bool $addLabels
* @return array
*/
public function getStateStatuses($state, $addLabels = true)
{
$key = sha1(json_encode([$state, $addLabels]));
if (isset($this->stateStatuses[$key])) {
return $this->stateStatuses[$key];
}
$statuses = [];
if (!is_array($state)) {
$state = [$state];
}
foreach ($state as $_state) {
$stateNode = $this->_getState($_state);
if ($stateNode) {
$collection = $this->orderStatusCollectionFactory->create()->addStateFilter($_state)->orderByLabel();
foreach ($collection as $item) {
$status = $item->getData('status');
if ($addLabels) {
$statuses[$status] = $this->getStatusLabel($status);
} else {
$statuses[] = $status;
}
}
}
}
$this->stateStatuses[$key] = $statuses;
return $statuses;
}
/**
* Retrieve states which are visible on front end
*
* @return array
*/
public function getVisibleOnFrontStatuses()
{
return $this->_getStatuses(true);
}
/**
* Get order statuses, invisible on frontend
*
* @return array
*/
public function getInvisibleOnFrontStatuses()
{
return $this->_getStatuses(false);
}
/**
* Get existing order statuses.
*
* Visible or invisible on frontend according to passed param.
*
* @param bool $visibility
* @return array
*/
protected function _getStatuses($visibility)
{
if ($this->statuses == null) {
$this->statuses = [
true => [],
false => [],
];
foreach ($this->_getCollection() as $item) {
$visible = (bool) $item->getData('visible_on_front');
$this->statuses[$visible][] = $item->getData('status');
}
}
return $this->statuses[(bool) $visibility];
}
/**
* Retrieve label by state and status
*
* @param string $state
* @param string $status
* @return \Magento\Framework\Phrase|string
* @since 101.0.0
*/
public function getStateLabelByStateAndStatus($state, $status)
{
foreach ($this->_getCollection() as $item) {
if ($item->getData('state') == $state && $item->getData('status') == $status) {
$label = $item->getData('label');
return __($label);
}
}
return $state;
}
}