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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Braintree\Model\Paypal;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Sales\Api\Data\OrderInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
/**
* The service to cancel an order and void authorization transaction.
*/
class OrderCancellationService
{
/**
* @var OrderRepositoryInterface
*/
private $orderRepository;
/**
* @var SearchCriteriaBuilder
*/
private $searchCriteriaBuilder;
/**
* @param SearchCriteriaBuilder $searchCriteriaBuilder
* @param OrderRepositoryInterface $orderRepository
*/
public function __construct(
SearchCriteriaBuilder $searchCriteriaBuilder,
OrderRepositoryInterface $orderRepository
) {
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
$this->orderRepository = $orderRepository;
}
/**
* Cancels an order and authorization transaction.
*
* @param string $incrementId
* @return bool
*/
public function execute(string $incrementId): bool
{
$order = $this->getOrder($incrementId);
if ($order === null) {
return false;
}
// `\Magento\Sales\Model\Service\OrderService::cancel` cannot be used for cancellation as the service uses
// the order repository with outdated payment method instance (ex. contains Vault instead of Braintree)
$order->cancel();
$this->orderRepository->save($order);
return true;
}
/**
* Gets order by increment ID.
*
* @param string $incrementId
* @return OrderInterface|null
*/
private function getOrder(string $incrementId)
{
$searchCriteria = $this->searchCriteriaBuilder->addFilter(OrderInterface::INCREMENT_ID, $incrementId)
->create();
$items = $this->orderRepository->getList($searchCriteria)
->getItems();
return array_pop($items);
}
}