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
<?php
/**
* @copyright Vertex. All rights reserved. https://www.vertexinc.com/
* @author Mediotype https://www.mediotype.com/
*/
namespace Vertex\Tax\Model\Plugin;
use Magento\Sales\Api\Data\InvoiceInterface;
use Magento\Sales\Api\Data\InvoiceItemExtensionFactory;
use Magento\Sales\Api\Data\InvoiceItemInterface;
use Magento\Sales\Api\InvoiceRepositoryInterface;
use Vertex\Tax\Model\Config;
use Vertex\Tax\Model\VertexTaxAttributeManager;
/**
* Plugin that adds Vertex Tax extension attributes when the Invoice Repository is called
*/
class InvoiceRepositoryPlugin
{
/** @var VertexTaxAttributeManager */
private $attributeManager;
/** @var Config */
private $config;
/** @var InvoiceItemExtensionFactory */
private $invoiceItemExtensionFactory;
/**
* @param VertexTaxAttributeManager $attributeManager
* @param InvoiceItemExtensionFactory $invoiceItemExtensionFactory
* @param Config $config
*/
public function __construct(
VertexTaxAttributeManager $attributeManager,
InvoiceItemExtensionFactory $invoiceItemExtensionFactory,
Config $config
) {
$this->attributeManager = $attributeManager;
$this->invoiceItemExtensionFactory = $invoiceItemExtensionFactory;
$this->config = $config;
}
/**
* Add Vertex extension attributes to an invoice's items after it is retrieved
*
* @param InvoiceRepositoryInterface $subject
* @param InvoiceInterface $invoice
* @return InvoiceInterface
*/
public function afterGet(InvoiceRepositoryInterface $subject, InvoiceInterface $invoice)
{
if (!$this->config->isVertexActive($invoice->getStoreId())) {
return $invoice;
}
$invoiceItems = $invoice->getItems();
$orderItemIds = $this->getOrderItemIdsFromInvoiceItemList($invoiceItems);
$taxCodes = $this->attributeManager->getTaxCodes($orderItemIds);
$vertexTaxCodes = $this->attributeManager->getVertexTaxCodes($orderItemIds);
$invoiceTextCodes = $this->attributeManager->getInvoiceTextCodes($orderItemIds);
$this->setInvoiceItemVertexExtensionAttributes(
$invoiceItems,
$vertexTaxCodes,
$invoiceTextCodes,
$taxCodes
);
return $invoice;
}
/**
* Retrieve the Order Item IDs from a list of Invoice Items
*
* @param InvoiceItemInterface[] $invoiceItems
* @return int[]
*/
private function getOrderItemIdsFromInvoiceItemList(array $invoiceItems)
{
return array_map(
function (InvoiceItemInterface $invoiceItem) {
return $invoiceItem->getOrderItemId();
},
$invoiceItems
);
}
/**
* Assign Invoice Item Vertex extension attributes to the Invoice Item object
*
* @param InvoiceItemInterface[] $invoiceItems
* @param string<int>[] $vertexTaxCodes
* @param string<int>[] $invoiceTextCodes
* @param string<int>[] $taxCodes
* @return void
*/
private function setInvoiceItemVertexExtensionAttributes(
array $invoiceItems,
array $vertexTaxCodes,
array $invoiceTextCodes,
array $taxCodes
) {
if ($invoiceItems === null) {
return;
}
foreach ($invoiceItems as $invoiceItem) {
$this->setVertexTaxCodes($invoiceItem, $vertexTaxCodes);
$this->setInvoiceTextCodes($invoiceItem, $invoiceTextCodes);
$this->setTaxCodes($invoiceItem, $taxCodes);
}
}
/**
* Set InvoiceTextCode extension attribute for Invoice Item
*
* @param InvoiceItemInterface $invoiceItem
* @param string<int>[] $invoiceTextCodes
* @return void
*/
private function setInvoiceTextCodes(InvoiceItemInterface $invoiceItem, array $invoiceTextCodes)
{
$extensionAttributes = $invoiceItem->getExtensionAttributes();
if ($extensionAttributes && $extensionAttributes->getInvoiceTextCodes()) {
return;
}
if ($invoiceTextCodes !== null && array_key_exists($invoiceItem->getOrderItemId(), $invoiceTextCodes)) {
$extensionAttributes = $extensionAttributes ?: $this->invoiceItemExtensionFactory->create();
$extensionAttributes->setInvoiceTextCodes($invoiceTextCodes[$invoiceItem->getOrderItemId()]);
$invoiceItem->setExtensionAttributes($extensionAttributes);
}
}
/**
* Set the TaxCode extension attribute for an Invoice Item
*
* @param InvoiceItemInterface $invoiceItem
* @param string<int>[] $taxCodes
* @return void
*/
private function setTaxCodes(InvoiceItemInterface $invoiceItem, array $taxCodes)
{
$extensionAttributes = $invoiceItem->getExtensionAttributes();
if ($extensionAttributes && $extensionAttributes->getTaxCodes()) {
return;
}
if ($taxCodes !== null && array_key_exists($invoiceItem->getOrderItemId(), $taxCodes)) {
$extensionAttributes = $extensionAttributes ?: $this->invoiceItemExtensionFactory->create();
$extensionAttributes->setTaxCodes($taxCodes[$invoiceItem->getOrderItemId()]);
$invoiceItem->setExtensionAttributes($extensionAttributes);
}
}
/**
* Set the VertexTaxCode extension attribute for an Invoice Item
*
* @param InvoiceItemInterface $invoiceItem
* @param string<int>[] $vertexTaxCodes
* @return void
*/
private function setVertexTaxCodes(InvoiceItemInterface $invoiceItem, array $vertexTaxCodes)
{
$extensionAttributes = $invoiceItem->getExtensionAttributes();
if ($extensionAttributes && $extensionAttributes->getVertexTaxCodes()) {
return;
}
if ($vertexTaxCodes !== null && array_key_exists($invoiceItem->getOrderItemId(), $vertexTaxCodes)) {
$extensionAttributes = $extensionAttributes ?: $this->invoiceItemExtensionFactory->create();
$extensionAttributes->setVertexTaxCodes($vertexTaxCodes[$invoiceItem->getOrderItemId()]);
$invoiceItem->setExtensionAttributes($extensionAttributes);
}
}
}