-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
CreditmemoLoader.php
251 lines (227 loc) · 7.66 KB
/
CreditmemoLoader.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
<?php
/**
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Controller\Adminhtml\Order;
use Magento\Framework\DataObject;
use Magento\Sales\Api\CreditmemoRepositoryInterface;
use Magento\Sales\Model\Order;
use Magento\Sales\Model\Order\CreditmemoFactory;
/**
* Loader for creditmemo
*
* @method CreditmemoLoader setCreditmemoId($id)
* @method CreditmemoLoader setCreditmemo($creditMemo)
* @method CreditmemoLoader setInvoiceId($id)
* @method CreditmemoLoader setOrderId($id)
* @method int getCreditmemoId()
* @method string getCreditmemo()
* @method int getInvoiceId()
* @method int getOrderId()
* @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
*/
class CreditmemoLoader extends DataObject
{
/**
* @var CreditmemoRepositoryInterface;
*/
protected $creditmemoRepository;
/**
* @var CreditmemoFactory;
*/
protected $creditmemoFactory;
/**
* @var \Magento\Sales\Model\OrderFactory
*/
protected $orderFactory;
/**
* @var \Magento\Sales\Api\InvoiceRepositoryInterface
*/
protected $invoiceRepository;
/**
* @var \Magento\Framework\Event\ManagerInterface
*/
protected $eventManager;
/**
* @var \Magento\Backend\Model\Session
*/
protected $backendSession;
/**
* @var \Magento\Framework\Message\ManagerInterface
*/
protected $messageManager;
/**
* @var \Magento\Framework\Registry
*/
protected $registry;
/**
* @var \Magento\CatalogInventory\Api\StockConfigurationInterface
*/
protected $stockConfiguration;
/**
* @param CreditmemoRepositoryInterface $creditmemoRepository
* @param CreditmemoFactory $creditmemoFactory
* @param \Magento\Sales\Model\OrderFactory $orderFactory
* @param \Magento\Sales\Api\InvoiceRepositoryInterface $invoiceRepository
* @param \Magento\Framework\Event\ManagerInterface $eventManager
* @param \Magento\Backend\Model\Session $backendSession
* @param \Magento\Framework\Message\ManagerInterface $messageManager
* @param \Magento\Framework\Registry $registry
* @param \Magento\CatalogInventory\Api\StockConfigurationInterface $stockConfiguration
* @param array $data
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
CreditmemoRepositoryInterface $creditmemoRepository,
CreditmemoFactory $creditmemoFactory,
\Magento\Sales\Model\OrderFactory $orderFactory,
\Magento\Sales\Api\InvoiceRepositoryInterface $invoiceRepository,
\Magento\Framework\Event\ManagerInterface $eventManager,
\Magento\Backend\Model\Session $backendSession,
\Magento\Framework\Message\ManagerInterface $messageManager,
\Magento\Framework\Registry $registry,
\Magento\CatalogInventory\Api\StockConfigurationInterface $stockConfiguration,
array $data = []
) {
$this->creditmemoRepository = $creditmemoRepository;
$this->creditmemoFactory = $creditmemoFactory;
$this->orderFactory = $orderFactory;
$this->invoiceRepository = $invoiceRepository;
$this->eventManager = $eventManager;
$this->backendSession = $backendSession;
$this->messageManager = $messageManager;
$this->registry = $registry;
$this->stockConfiguration = $stockConfiguration;
parent::__construct($data);
}
/**
* Get requested items qtys and return to stock flags
*
* @return array
*/
protected function _getItemData()
{
$data = $this->getCreditmemo();
if (!$data) {
$data = $this->backendSession->getFormData(true);
}
if (isset($data['items'])) {
$qtys = $data['items'];
} else {
$qtys = [];
}
return $qtys;
}
/**
* Check if creditmeno can be created for order
*
* @param Order $order
* @return bool
*/
protected function _canCreditmemo($order)
{
/**
* Check order existing
*/
if (!$order->getId()) {
$this->messageManager->addErrorMessage(__('The order no longer exists.'));
return false;
}
/**
* Check creditmemo create availability
*/
if (!$order->canCreditmemo()) {
$this->messageManager->addErrorMessage(__('We can\'t create credit memo for the order.'));
return false;
}
return true;
}
/**
* Inits invoice
*
* @param Order $order
* @return $this|bool
*/
protected function _initInvoice($order)
{
$invoiceId = $this->getInvoiceId();
if ($invoiceId) {
$invoice = $this->invoiceRepository->get($invoiceId);
$invoice->setOrder($order);
if ($invoice->getId()) {
return $invoice;
}
}
return false;
}
/**
* Initialize creditmemo model instance
*
* @return \Magento\Sales\Model\Order\Creditmemo|false
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function load()
{
$creditmemo = false;
$creditmemoId = $this->getCreditmemoId();
$orderId = $this->getOrderId();
if ($creditmemoId) {
try {
$creditmemo = $this->creditmemoRepository->get($creditmemoId);
} catch (\Exception $e) {
$this->messageManager->addErrorMessage(__('This creditmemo no longer exists.'));
return false;
}
} elseif ($orderId) {
$data = $this->getCreditmemo();
$order = $this->orderFactory->create()->load($orderId);
$invoice = $this->_initInvoice($order);
if (!$this->_canCreditmemo($order)) {
return false;
}
$savedData = $this->_getItemData();
$qtys = [];
$backToStock = [];
foreach ($savedData as $orderItemId => $itemData) {
if (isset($itemData['qty'])) {
$qtys[$orderItemId] = $itemData['qty'];
}
if (isset($itemData['back_to_stock'])) {
$backToStock[$orderItemId] = true;
}
}
$data['qtys'] = $qtys;
if ($invoice) {
$creditmemo = $this->creditmemoFactory->createByInvoice($invoice, $data);
} else {
$creditmemo = $this->creditmemoFactory->createByOrder($order, $data);
}
/**
* Process back to stock flags
*/
foreach ($creditmemo->getAllItems() as $creditmemoItem) {
$orderItem = $creditmemoItem->getOrderItem();
$parentId = $orderItem->getParentItemId();
if ($parentId && isset($backToStock[$parentId]) && $backToStock[$parentId]) {
$creditmemoItem->setBackToStock(true);
} elseif (isset($backToStock[$orderItem->getId()])) {
$creditmemoItem->setBackToStock(true);
} elseif (empty($savedData)) {
$creditmemoItem->setBackToStock(
$this->stockConfiguration->isAutoReturnEnabled()
);
} else {
$creditmemoItem->setBackToStock(false);
}
}
}
$this->eventManager->dispatch(
'adminhtml_sales_order_creditmemo_register_before',
['creditmemo' => $creditmemo, 'input' => $this->getCreditmemo()]
);
$this->registry->register('current_creditmemo', $creditmemo);
return $creditmemo;
}
}