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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Tax\Block\Item\Price;
use Magento\Framework\Pricing\PriceCurrencyInterface;
use Magento\Framework\Pricing\Render as PricingRender;
use Magento\Framework\View\Element\Template\Context;
use Magento\Quote\Model\Quote\Item\AbstractItem as QuoteItem;
use Magento\Sales\Model\Order\CreditMemo\Item as CreditMemoItem;
use Magento\Sales\Model\Order\Invoice\Item as InvoiceItem;
use Magento\Sales\Model\Order\Item as OrderItem;
use Magento\Tax\Helper\Data as TaxHelper;
/**
* Item price render block
*
* @api
* @author Magento Core Team <core@magentocommerce.com>
* @since 100.0.2
*/
class Renderer extends \Magento\Framework\View\Element\Template
{
/**
* @var \Magento\Tax\Helper\Data
*/
protected $taxHelper;
/**
* @var QuoteItem|OrderItem|InvoiceItem|CreditMemoItem
*/
protected $item;
/**
* @var string|int|null
*/
protected $storeId = null;
/**
* Set the display area, e.g., cart, sales, etc.
*
* @var string
*/
protected $zone = null;
/**
* @var PriceCurrencyInterface
*/
protected $priceCurrency;
/**
* @param Context $context
* @param TaxHelper $taxHelper
* @param PriceCurrencyInterface $priceCurrency
* @param array $data
*/
public function __construct(
Context $context,
TaxHelper $taxHelper,
PriceCurrencyInterface $priceCurrency,
array $data = []
) {
$this->priceCurrency = $priceCurrency;
$this->taxHelper = $taxHelper;
if (isset($data['zone'])) {
$this->zone = $data['zone'];
}
parent::__construct($context, $data);
}
/**
* Set item for render
*
* @param QuoteItem|OrderItem|InvoiceItem|CreditMemoItem $item
* @return $this
*/
public function setItem($item)
{
$this->item = $item;
$this->storeId = $item->getStoreId();
return $this;
}
/**
* Get display zone
*
* @return string|null
*/
public function getZone()
{
return $this->zone;
}
/**
* Set display zone
*
* @param string $zone
* @return $this
*/
public function setZone($zone)
{
$this->zone = $zone;
return $this;
}
/**
* @return int|null|string
*/
public function getStoreId()
{
return $this->storeId;
}
/**
* Get quote or order item
*
* @return CreditMemoItem|InvoiceItem|OrderItem|QuoteItem
*/
public function getItem()
{
return $this->item;
}
/**
* Return whether display setting is to display price including tax
*
* @return bool
*/
public function displayPriceInclTax()
{
switch ($this->zone) {
case PricingRender::ZONE_CART:
return $this->taxHelper->displayCartPriceInclTax($this->storeId);
case PricingRender::ZONE_EMAIL:
case PricingRender::ZONE_SALES:
return $this->taxHelper->displaySalesPriceInclTax($this->storeId);
default:
return $this->taxHelper->displayCartPriceInclTax($this->storeId);
}
}
/**
* Return whether display setting is to display price excluding tax
*
* @return bool
*/
public function displayPriceExclTax()
{
switch ($this->zone) {
case PricingRender::ZONE_CART:
return $this->taxHelper->displayCartPriceExclTax($this->storeId);
case PricingRender::ZONE_EMAIL:
case PricingRender::ZONE_SALES:
return $this->taxHelper->displaySalesPriceExclTax($this->storeId);
default:
return $this->taxHelper->displayCartPriceExclTax($this->storeId);
}
}
/**
* Return whether display setting is to display both price including tax and price excluding tax
*
* @return bool
*/
public function displayBothPrices()
{
switch ($this->zone) {
case PricingRender::ZONE_CART:
return $this->taxHelper->displayCartBothPrices($this->storeId);
case PricingRender::ZONE_EMAIL:
case PricingRender::ZONE_SALES:
return $this->taxHelper->displaySalesBothPrices($this->storeId);
default:
return $this->taxHelper->displayCartBothPrices($this->storeId);
}
}
/**
* Format price
*
* @param float $price
* @return string
*/
public function formatPrice($price)
{
$item = $this->getItem();
if ($item instanceof QuoteItem) {
return $this->priceCurrency->format(
$price,
true,
PriceCurrencyInterface::DEFAULT_PRECISION,
$item->getStore()
);
} elseif ($item instanceof OrderItem) {
return $item->getOrder()->formatPrice($price);
} else {
return $item->getOrderItem()->getOrder()->formatPrice($price);
}
}
/**
* Get item price in display currency or order currency depending
* on item type
*
* @return float
*/
public function getItemDisplayPriceExclTax()
{
$item = $this->getItem();
if ($item instanceof QuoteItem) {
return $item->getCalculationPrice();
} else {
return $item->getPrice();
}
}
/**
* Return the total amount minus discount
*
* @param OrderItem|InvoiceItem|CreditmemoItem $item
* @return mixed
*/
public function getTotalAmount($item)
{
$totalAmount = $item->getRowTotal()
- $item->getDiscountAmount()
+ $item->getTaxAmount()
+ $item->getDiscountTaxCompensationAmount();
return $totalAmount;
}
/**
* Return the total amount minus discount
*
* @param OrderItem|InvoiceItem|CreditmemoItem $item
* @return mixed
*/
public function getBaseTotalAmount($item)
{
$totalAmount = $item->getBaseRowTotal()
- $item->getBaseDiscountAmount()
+ $item->getBaseTaxAmount()
+ $item->getBaseDiscountTaxCompensationAmount();
return $totalAmount;
}
}