1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Finance module for HiPanel |
4
|
|
|
* |
5
|
|
|
* @link https://github.com/hiqdev/hipanel-module-finance |
6
|
|
|
* @package hipanel-module-finance |
7
|
|
|
* @license BSD-3-Clause |
8
|
|
|
* @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/) |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
namespace hipanel\modules\finance\cart; |
12
|
|
|
|
13
|
|
|
use hipanel\modules\finance\logic\Calculator; |
14
|
|
|
use hipanel\modules\finance\models\Calculation; |
|
|
|
|
15
|
|
|
use hipanel\modules\finance\models\Value; |
16
|
|
|
use hiqdev\yii2\cart\ShoppingCart; |
17
|
|
|
use Yii; |
18
|
|
|
use yii\web\UnprocessableEntityHttpException; |
19
|
|
|
use yz\shoppingcart\CartActionEvent; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* Class CartCalculator provides API to calculate [[cart]] positions value. |
23
|
|
|
* |
24
|
|
|
* Usage: |
25
|
|
|
* |
26
|
|
|
* ```php |
27
|
|
|
* $calculator = new CartCalculator($this->cart); |
28
|
|
|
* |
29
|
|
|
* $calculator->run(); // will calculate prices for all cart positions and update them |
30
|
|
|
* ``` |
31
|
|
|
* |
32
|
|
|
* Also can be bound to some cart event as handler: |
33
|
|
|
* |
34
|
|
|
* ```php |
35
|
|
|
* $cart->on(Cart::EVENT_UPDATE, [CartCalculator::class, 'handle']); |
36
|
|
|
* ``` |
37
|
|
|
*/ |
38
|
|
|
final class CartCalculator extends Calculator |
39
|
|
|
{ |
40
|
|
|
/** |
41
|
|
|
* @var AbstractCartPosition[] |
42
|
|
|
*/ |
43
|
|
|
protected $models; |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* @var ShoppingCart |
47
|
|
|
*/ |
48
|
|
|
public $cart; |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @var CartActionEvent |
52
|
|
|
*/ |
53
|
|
|
public $event; |
54
|
|
|
/** |
55
|
|
|
* @var string[] |
56
|
|
|
*/ |
57
|
|
|
private $positionsBeingRemoved = []; |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Creates the instance of the object and runs the calculation. |
61
|
|
|
* |
62
|
|
|
* @param CartActionEvent $event The event |
63
|
|
|
* @void |
64
|
|
|
*/ |
65
|
|
|
public static function handle($event) |
66
|
|
|
{ |
67
|
|
|
/** @var ShoppingCart $cart */ |
68
|
|
|
$cart = $event->sender; |
69
|
|
|
|
70
|
|
|
$calculator = new static($cart); |
71
|
|
|
if ($event->action === CartActionEvent::ACTION_BEFORE_REMOVE && $event->position !== null) { |
72
|
|
|
$calculator->positionsBeingRemoved[] = $event->position->getId(); |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** @noinspection UnusedFunctionResultInspection */ |
76
|
|
|
$calculator->execute(); |
77
|
|
|
} |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* @param ShoppingCart $cart |
81
|
|
|
*/ |
82
|
|
|
public function __construct(ShoppingCart $cart) |
83
|
|
|
{ |
84
|
|
|
$this->cart = $cart; |
85
|
|
|
|
86
|
|
|
parent::__construct($this->cart->positions); |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* {@inheritdoc} |
91
|
|
|
*/ |
92
|
|
|
public function execute() |
93
|
|
|
{ |
94
|
|
|
// Do not try to calculate position that is being removed |
95
|
|
|
foreach ($this->positionsBeingRemoved as $id) { |
96
|
|
|
unset($this->models[$id]); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
try { |
100
|
|
|
parent::execute(); |
101
|
|
|
} catch (UnprocessableEntityHttpException $e) { |
102
|
|
|
throw CartIsBrokenException::forCart( |
103
|
|
|
$this->cart, |
104
|
|
|
Yii::t('hipanel:finance', 'Failed to calculate cart: {reason}', ['reason' => $e->getMessage()]) |
105
|
|
|
); |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
$this->applyCalculations(); |
109
|
|
|
return $this->calculations; |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
/** |
113
|
|
|
* Updates positions using the calculations provided with [[getCalculation]]. |
114
|
|
|
*/ |
115
|
|
|
private function applyCalculations() |
116
|
|
|
{ |
117
|
|
|
foreach ($this->models as $position) { |
118
|
|
|
$id = $position->id; |
119
|
|
|
$calculation = $this->getCalculation($id); |
120
|
|
|
if (!$calculation instanceof Calculation) { |
121
|
|
|
Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because of failed value calculation. Normally this should never happen.', 'hipanel.cart'); |
122
|
|
|
$this->cart->removeById($position->id); |
123
|
|
|
break; |
124
|
|
|
} |
125
|
|
|
|
126
|
|
|
$value = $this->getValue($position, $calculation); |
127
|
|
|
$this->ensureCurrencyIsNotConflictingWithCart($position, $value); |
128
|
|
|
|
129
|
|
|
$position->setPrice($value->price); |
130
|
|
|
$position->setValue($value->value); |
131
|
|
|
$position->setCurrency($value->currency); |
132
|
|
|
} |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
private function getValue(AbstractCartPosition $position, Calculation $calculation): Value |
136
|
|
|
{ |
137
|
|
|
$currency = Yii::$app->params['currency']; |
138
|
|
|
|
139
|
|
|
/** @var Value $value */ |
140
|
|
|
$value = $calculation->forCurrency($currency); |
141
|
|
|
if (!$value instanceof Value) { |
142
|
|
|
Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because calculation for currency "' . $value->currency . '" is not available', 'hipanel.cart'); |
143
|
|
|
$this->cart->removeById($position->id); |
144
|
|
|
} |
145
|
|
|
|
146
|
|
|
return $value; |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
private function ensureCurrencyIsNotConflictingWithCart(AbstractCartPosition $position, Value $value): void |
150
|
|
|
{ |
151
|
|
|
if ($this->cart->getCurrency() && $value->currency !== $this->cart->getCurrency()) { |
152
|
|
|
throw MultiCurrencyException::forPosition($position, $this->cart, Yii::t('cart', 'Sorry, but now it is impossible to add the position with different currencies to the cart. Pay the current order to add this item to the cart.')); |
153
|
|
|
} |
154
|
|
|
} |
155
|
|
|
} |
156
|
|
|
|
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/Foo.php
are loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php
However, as
OtherDir/Foo.php
does not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php
, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: