/
Cart.php
439 lines (388 loc) · 9.84 KB
/
Cart.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Payment\Model;
/**
* Provide methods for collecting cart items information of specific sales model entity
*
* @api
* @since 100.0.2
*/
class Cart
{
/**#@+
* Amounts
*/
const AMOUNT_TAX = 'tax';
const AMOUNT_SHIPPING = 'shipping';
const AMOUNT_DISCOUNT = 'discount';
const AMOUNT_SUBTOTAL = 'subtotal';
/**#@-*/
/**#@-*/
protected $_salesModel;
/**
* Core event manager proxy
*
* @var \Magento\Framework\Event\ManagerInterface
*/
protected $_eventManager;
/**
* Amounts
*
* @var array
*/
protected $_amounts;
/**
* Custom items list
*
* @var array
*/
protected $_customItems = [];
/**
* Items imported from sales model
*
* @var array
*/
protected $_salesModelItems = [];
/**
* Flags that indicates whether discount, shopping and taxes should be transferred as cart item
*
* @var array
*/
protected $_transferFlags = [];
/**
* Flags which indicates whether items data is outdated and has to be recollected
*
* @var bool
*/
protected $_itemsCollectingRequired = true;
/**
* @param \Magento\Payment\Model\Cart\SalesModel\Factory $salesModelFactory
* @param \Magento\Framework\Event\ManagerInterface $eventManager
* @param \Magento\Quote\Api\Data\CartInterface $salesModel
*/
public function __construct(
\Magento\Payment\Model\Cart\SalesModel\Factory $salesModelFactory,
\Magento\Framework\Event\ManagerInterface $eventManager,
$salesModel
) {
$this->_eventManager = $eventManager;
$this->_salesModel = $salesModelFactory->create($salesModel);
$this->_resetAmounts();
}
/**
* Return payment cart sales model
*
* @return \Magento\Payment\Model\Cart\SalesModel\SalesModelInterface
* @api
*/
public function getSalesModel()
{
return $this->_salesModel;
}
/**
* Add amount to existing tax amount
*
* @param float $taxAmount
* @return void
* @api
*/
public function addTax($taxAmount)
{
$this->_addAmount(self::AMOUNT_TAX, $taxAmount);
}
/**
* Set tax. Old value will be overwritten
*
* @param float $taxAmount
* @return void
* @api
*/
public function setTax($taxAmount)
{
$this->_setAmount(self::AMOUNT_TAX, $taxAmount);
}
/**
* Get tax amount
*
* @return float
* @api
*/
public function getTax()
{
return $this->_getAmount(self::AMOUNT_TAX);
}
/**
* Add amount to existing discount amount
*
* @param float $discountAmount
* @return void
* @api
*/
public function addDiscount($discountAmount)
{
$this->_addAmount(self::AMOUNT_DISCOUNT, $discountAmount);
}
/**
* Set discount. Old value will be overwritten
*
* @param float $discountAmount
* @return void
* @api
*/
public function setDiscount($discountAmount)
{
$this->_setAmount(self::AMOUNT_DISCOUNT, $discountAmount);
}
/**
* Get discount amount
*
* @return float
* @api
*/
public function getDiscount()
{
return $this->_getAmount(self::AMOUNT_DISCOUNT);
}
/**
* Add amount to existing shipping amount
*
* @param float $shippingAmount
* @return void
* @api
*/
public function addShipping($shippingAmount)
{
$this->_addAmount(self::AMOUNT_SHIPPING, $shippingAmount);
}
/**
* Set shipping. Old value will be overwritten
*
* @param float $shippingAmount
* @return void
* @api
*/
public function setShipping($shippingAmount)
{
$this->_setAmount(self::AMOUNT_SHIPPING, $shippingAmount);
}
/**
* Get shipping amount
*
* @return float
* @api
*/
public function getShipping()
{
return $this->_getAmount(self::AMOUNT_SHIPPING);
}
/**
* Add amount to existing subtotal amount
*
* @param float $subtotalAmount
* @return void
* @api
*/
public function addSubtotal($subtotalAmount)
{
$this->_addAmount(self::AMOUNT_SUBTOTAL, $subtotalAmount);
}
/**
* Get subtotal amount
*
* @return float
* @api
*/
public function getSubtotal()
{
return $this->_getAmount(self::AMOUNT_SUBTOTAL);
}
/**
* Add custom item (such as discount as line item, shipping as line item, etc)
*
* @param string $name
* @param int $qty
* @param float $amount
* @param string|null $identifier
* @return void
* @api
*/
public function addCustomItem($name, $qty, $amount, $identifier = null)
{
$this->_customItems[] = $this->_createItemFromData($name, $qty, $amount, $identifier);
}
/**
* Get all cart items
*
* @return array
* @api
*/
public function getAllItems()
{
$this->_collectItemsAndAmounts();
return array_merge($this->_salesModelItems, $this->_customItems);
}
/**
* Get shipping, tax, subtotal and discount amounts all together
*
* @return array
* @api
*/
public function getAmounts()
{
$this->_collectItemsAndAmounts();
return $this->_amounts;
}
/**
* Specify that shipping should be transferred as cart item
*
* @return void
* @api
*/
public function setTransferShippingAsItem()
{
$this->_setTransferFlag(self::AMOUNT_SHIPPING, true);
}
/**
* Specify that discount should be transferred as cart item
*
* @return void
* @api
*/
public function setTransferDiscountAsItem()
{
$this->_setTransferFlag(self::AMOUNT_DISCOUNT, true);
}
/**
* Collect all items, discounts, taxes, shipping to cart
*
* @return void
*/
protected function _collectItemsAndAmounts()
{
if (!$this->_itemsCollectingRequired) {
return;
}
$this->_itemsCollectingRequired = false;
$this->_salesModelItems = [];
$this->_customItems = [];
$this->_resetAmounts();
$this->_eventManager->dispatch('payment_cart_collect_items_and_amounts', ['cart' => $this]);
$this->_importItemsFromSalesModel();
$this->_calculateCustomItemsSubtotal();
}
/**
* Import items from sales model
*
* @return void
*/
protected function _importItemsFromSalesModel()
{
$this->_salesModelItems = [];
foreach ($this->_salesModel->getAllItems() as $item) {
if ($item->getParentItem()) {
continue;
}
$this->_salesModelItems[] = $this->_createItemFromData(
$item->getName(),
$item->getQty(),
$item->getPrice(),
$item->getOriginalItem()->getId()
);
}
$this->addSubtotal($this->_salesModel->getBaseSubtotal());
$this->addTax($this->_salesModel->getBaseTaxAmount());
$this->addShipping($this->_salesModel->getBaseShippingAmount());
$this->addDiscount(abs($this->_salesModel->getBaseDiscountAmount()));
}
/**
* Calculate subtotal from custom items
*
* @return void
*/
protected function _calculateCustomItemsSubtotal()
{
if (!empty($this->_transferFlags[self::AMOUNT_DISCOUNT]) && $this->getDiscount()) {
$this->addCustomItem(__('Discount'), 1, -1.00 * $this->getDiscount());
$this->setDiscount(0);
}
if (!empty($this->_transferFlags[self::AMOUNT_SHIPPING]) && $this->getShipping()) {
$this->addCustomItem(__('Shipping'), 1, $this->getShipping());
$this->setShipping(0);
}
foreach ($this->_customItems as $item) {
$this->_amounts[self::AMOUNT_SUBTOTAL] += $item->getAmount();
}
}
/**
* @param string $flagType
* @param bool $value
* @return void
*/
protected function _setTransferFlag($flagType, $value)
{
$this->_transferFlags[$flagType] = (bool)$value;
$this->_itemsCollectingRequired = true;
}
/**
* @param string $amountType
* @param float $amount
* @return void
*/
protected function _setAmount($amountType, $amount)
{
$this->_amounts[$amountType] = (double)$amount;
}
/**
* @param string $amountType
* @param float $amount
* @return void
*/
protected function _addAmount($amountType, $amount)
{
$this->_amounts[$amountType] += (double)$amount;
}
/**
* Get amount of specified type
*
* @param string $amountType
* @return float
*/
protected function _getAmount($amountType)
{
return $this->_amounts[$amountType];
}
/**
* Create item object from item data
*
* @param string $name
* @param int $qty
* @param float $amount
* @param null|string $identifier
* @return \Magento\Framework\DataObject
*/
protected function _createItemFromData($name, $qty, $amount, $identifier = null)
{
$item = new \Magento\Framework\DataObject(['name' => $name, 'qty' => $qty, 'amount' => (double)$amount]);
if ($identifier) {
$item->setData('id', $identifier);
}
return $item;
}
/**
* Set all amount types to zero
*
* @return void
*/
protected function _resetAmounts()
{
$this->_amounts = [
self::AMOUNT_DISCOUNT => 0,
self::AMOUNT_SHIPPING => 0,
self::AMOUNT_SUBTOTAL => 0,
self::AMOUNT_TAX => 0,
];
}
}