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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model;
use Magento\Framework\App\ResourceConnection;
use Magento\Sales\Api\CreditmemoRepositoryInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Sales\Api\RefundOrderInterface;
use Magento\Sales\Model\Order\Config as OrderConfig;
use Magento\Sales\Model\Order\Creditmemo\NotifierInterface;
use Magento\Sales\Model\Order\CreditmemoDocumentFactory;
use Magento\Sales\Model\Order\OrderStateResolverInterface;
use Magento\Sales\Model\Order\RefundAdapterInterface;
use Magento\Sales\Model\Order\Validation\RefundOrderInterface as RefundOrderValidator;
use Psr\Log\LoggerInterface;
/**
* Class RefundOrder
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class RefundOrder implements RefundOrderInterface
{
/**
* @var ResourceConnection
*/
private $resourceConnection;
/**
* @var OrderStateResolverInterface
*/
private $orderStateResolver;
/**
* @var OrderRepositoryInterface
*/
private $orderRepository;
/**
* @var CreditmemoRepositoryInterface
*/
private $creditmemoRepository;
/**
* @var RefundAdapterInterface
*/
private $refundAdapter;
/**
* @var CreditmemoDocumentFactory
*/
private $creditmemoDocumentFactory;
/**
* @var RefundOrderValidator
*/
private $validator;
/**
* @var NotifierInterface
*/
private $notifier;
/**
* @var OrderConfig
*/
private $config;
/**
* @var LoggerInterface
*/
private $logger;
/**
* RefundOrder constructor.
*
* @param ResourceConnection $resourceConnection
* @param OrderStateResolverInterface $orderStateResolver
* @param OrderRepositoryInterface $orderRepository
* @param CreditmemoRepositoryInterface $creditmemoRepository
* @param RefundAdapterInterface $refundAdapter
* @param CreditmemoDocumentFactory $creditmemoDocumentFactory
* @param RefundOrderValidator $validator
* @param NotifierInterface $notifier
* @param OrderConfig $config
* @param LoggerInterface $logger
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
ResourceConnection $resourceConnection,
OrderStateResolverInterface $orderStateResolver,
OrderRepositoryInterface $orderRepository,
CreditmemoRepositoryInterface $creditmemoRepository,
RefundAdapterInterface $refundAdapter,
CreditmemoDocumentFactory $creditmemoDocumentFactory,
RefundOrderValidator $validator,
NotifierInterface $notifier,
OrderConfig $config,
LoggerInterface $logger
) {
$this->resourceConnection = $resourceConnection;
$this->orderStateResolver = $orderStateResolver;
$this->orderRepository = $orderRepository;
$this->creditmemoRepository = $creditmemoRepository;
$this->refundAdapter = $refundAdapter;
$this->creditmemoDocumentFactory = $creditmemoDocumentFactory;
$this->validator = $validator;
$this->notifier = $notifier;
$this->config = $config;
$this->logger = $logger;
}
/**
* @inheritdoc
*/
public function execute(
$orderId,
array $items = [],
$notify = false,
$appendComment = false,
\Magento\Sales\Api\Data\CreditmemoCommentCreationInterface $comment = null,
\Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface $arguments = null
) {
$connection = $this->resourceConnection->getConnection('sales');
$order = $this->orderRepository->get($orderId);
$creditmemo = $this->creditmemoDocumentFactory->createFromOrder(
$order,
$items,
$comment,
($appendComment && $notify),
$arguments
);
$validationMessages = $this->validator->validate(
$order,
$creditmemo,
$items,
$notify,
$appendComment,
$comment,
$arguments
);
if ($validationMessages->hasMessages()) {
throw new \Magento\Sales\Exception\DocumentValidationException(
__("Creditmemo Document Validation Error(s):\n" . implode("\n", $validationMessages->getMessages()))
);
}
$connection->beginTransaction();
try {
$creditmemo->setState(\Magento\Sales\Model\Order\Creditmemo::STATE_REFUNDED);
$order->setCustomerNoteNotify($notify);
$order = $this->refundAdapter->refund($creditmemo, $order);
$order->setState(
$this->orderStateResolver->getStateForOrder($order, [])
);
$order->setStatus($this->config->getStateDefaultStatus($order->getState()));
$order = $this->orderRepository->save($order);
$creditmemo = $this->creditmemoRepository->save($creditmemo);
$connection->commit();
} catch (\Exception $e) {
$this->logger->critical($e);
$connection->rollBack();
throw new \Magento\Sales\Exception\CouldNotRefundException(
__('Could not save a Creditmemo, see error log for details')
);
}
if ($notify) {
if (!$appendComment) {
$comment = null;
}
$this->notifier->notify($order, $creditmemo, $comment);
}
return $creditmemo->getEntityId();
}
}