-
Notifications
You must be signed in to change notification settings - Fork 2
/
Payload.php
264 lines (249 loc) · 8.45 KB
/
Payload.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
<?php
namespace Dfe\OrderNotifier;
use Magento\Catalog\Helper\Image as ImageH;
use Magento\Catalog\Model\Product as P;
use Magento\Customer\Model\CustomerRegistry;
use Magento\Framework\App\ObjectManager as OM;
use Magento\Framework\App\Request\Http as RequestHttp;
use Magento\Framework\App\RequestInterface as IRequest;
use Magento\Framework\DataObject as _DO;
use Magento\Framework\HTTP\PhpEnvironment\RemoteAddress as RA;
use Magento\Framework\View\Config as ViewConfig;
use Magento\Framework\View\ConfigInterface as ViewConfigI;
use Magento\Sales\Api\Data\OrderAddressInterface as IOA;
use Magento\Sales\Api\Data\OrderItemInterface as IOI;
use Magento\Sales\Model\Order as O;
use Magento\Sales\Model\Order\Address as OA;
use Magento\Sales\Model\Order\Item as OI;
// 2018-08-11 Dmitry Fedyuk https://www.upwork.com/fl/mage2pro
final class Payload {
/**
* 2018-08-11
* @used-by get()
* @param IOA|OA|null $a
* @return array(string => mixed)
*/
private function address(IOA $a) {return !$a ? [] : self::remove_objects($a);}
/**
* 2018-08-11
* @used-by get()
* @return array(string => mixed)
*/
private function items() {return self::oqi_leafs($this->_o, function(OI $i) {return [
// 2018-09-05
// «Add product IDs to line items»
// https://github.com/mage2pro/order-notifier/issues/5
'id' => $i->getProductId()
,'image' => self::product_image_url($i->getProduct())
,'name' => $i->getName()
,'price' => self::oqi_price($i)
,'price_with_discount' => self::oqi_price($i, false, true)
,'price_with_discount_and_tax' => self::oqi_price($i, true, true)
,'price_with_tax' => self::oqi_price($i, true)
,'qty' => intval($i->getQtyOrdered())
// 2018-09-05 «Add SKUs to line items»: https://github.com/mage2pro/order-notifier/issues/2
,'sku' => $i->getSku()
,'tax_rate' => self::oqi_tax_rate($i)
,'url' => self::oqi_url($i)
];});}
/**
* 2018-08-11
* @used-by get()
* @return array(string => mixed)
*/
private function payment() {return array_filter(
self::remove_objects($this->_o->getPayment())
,function($k) {return 0 !== strpos($k, 'cc_');}
,ARRAY_FILTER_USE_KEY
);}
/**
* 2018-08-11
* @used-by get()
* @return array(string => mixed)
*/
private function visitor() {
$om = OM::getInstance(); /** @var OM $om */
$ra = $om->get(RA::class); /** @var RA $a */
$req = $om->get(IRequest::class); /** @var IRequest|RequestHttp $req */
return self::clean([
'http_user_agent' => $req->getHeader('user-agent')
,'http_x_forwarded_for' => @$_ENV['HTTP_X_FORWARDED_FOR']
,'http_via' => @$_ENV['HTTP_VIA']
,'remote_addr' => $ra->getRemoteAddress()
]);
}
/**
* 2018-08-11
* @used-by get()
* @var O
*/
private $_o;
/**
* 2018-08-11
* @used-by \Dfe\OrderNotifier\Observer\OrderSaveAfter::execute()
* @param O $o
* @return array(string => mixed)
*/
static function get(O $o) {
$om = OM::getInstance(); /** @var OM $om */
$cr = $om->get(CustomerRegistry::class); /** @var CustomerRegistry $cr */
$i = new self; $i->_o = $o; return [
'billing_address' => $i->address($o->getBillingAddress())
,'customer' => !($cid = $o->getCustomerId()) ? [] : self::remove_objects($cr->retrieve($cid))
,'line_items' => $i->items()
,'payment' => $i->payment()
,'shipping_address' => $i->address($o->getShippingAddress())
,'visitor' => $i->visitor()
] + self::remove_objects($o);
}
/**
* 2015-02-07
* @param mixed[] $a
* @return mixed[]
*/
private static function clean($a) {return array_filter($a, function($v) {return !in_array(
$v, ['', null, [], false], true
);});}
/**
* 2016-09-07
* @param O $oq
* @param \Closure $f
* @return array(int => mixed)
*/
private static function oqi_leafs($oq, \Closure $f) {return array_map($f, array_values(
array_filter($oq->getItems(), function($i) {/** @var OI $i */ return !$i->getChildrenItems();})
));}
/**
* 2016-05-03
* 2017-09-25 The function returns the product unit price, not the order row price.
* 2017-09-30
* I have added the $afterDiscount flag.
* It is used oly for the shopping cart price rules.
* $afterDiscount = false: the functon will return a result BEFORE discounts subtraction.
* $afterDiscount = true: the functon will return a result AFTER discounts subtraction.
* For now, I use $afterDiscount = true only for Yandex.Market:
* Yandex.Kassa does not provide a possibility to specify the shopping cart discounts in a separayte row,
* so I use $afterDiscount = true.
* @used-by df_oqi_tax_rate()
* @param OI|IOI $i
* @param bool $withTax [optional]
* @param bool $withDiscount [optional]
* @return float
*/
private static function oqi_price($i, $withTax = false, $withDiscount = false) {
$r = floatval($withTax ? $i->getPriceInclTax() : $i->getPrice()) ?: (
$i->getParentItem() ? self::oqi_price($i->getParentItem(), $withTax) : .0
); /** @var float $r */
/**
* 2017-09-30
* We should use @uses df_oqi_top(), because the `discount_amount` and `base_discount_amount` fields
* are not filled for the configurable children.
*/
return !$withDiscount ? $r : ($r - self::oqi_top($i)->getDiscountAmount() / intval($i->getQtyOrdered()));
}
/**
* 2017-03-06
* Возвращает налоговую ставку для позиции заказа в процентах.
* $asInteger == false: 17.5% => 17.5.
* $asInteger == true: 17.5% => 1750
* 2017-09-30
* @todo Why do not just use \Magento\Sales\Model\Order\Item::getTaxPercent()?
* @param OI $i
* @param bool $asInteger [optional]
* @return float|int
*/
private static function oqi_tax_rate($i, $asInteger = false) {
$r = self::tax_rate(self::oqi_price($i, true), self::oqi_price($i)); /** @var float $r */
return !$asInteger ? $r : round(100 * $r);
}
/**
* 2016-08-18
* @param OI $i
* @return OI
*/
private static function oqi_top($i) {return $i->getParentItem() ?: $i;}
/**
* 2017-02-01
* @param OI $i
* @return string
*/
private static function oqi_url($i) {return self::oqi_top($i)->getProduct()->getProductUrl();}
/**
* 2016-04-23
* How to get an image URL for a product programmatically?
* https://mage2.pro/t/1313
* How is @uses \Magento\Catalog\Helper\Image::getUrl() implemented and used?
* https://mage2.pro/t/1316
* @param P $p
* @param string|null $type [optional]
* @param array(string => string) $attrs [optional]
* @return string
*/
private static function product_image_url(P $p, $type = null, $attrs = []) {
$om = OM::getInstance(); /** @var OM $om */
$h = $om->get(ImageH::class); /** @var ImageH $h */
$vc = $om->get(ViewConfigI::class); /** @var ViewConfig|ViewConfigI $vc */
/** @var string|null $r */
if ($type) {
$r = $h
->init($p, $type, ['type' => $type] + $attrs + $vc->getViewConfig()->getMediaAttributes(
'Magento_Catalog', ImageH::MEDIA_TYPE_CONFIG_NODE, $type
))
->getUrl()
;
}
else {
/**
* 2016-05-02
* How is @uses \Magento\Catalog\Model\Product::getMediaAttributes() implemented and used?
* https://mage2.pro/t/1505
* @var string[] $types
*/
$types = array_keys($p->getMediaAttributes());
// Give priority to the «image» attribute.
$key = array_search('image', $types); /** @var int|null $key */
if (false !== $key) {
unset($types[$key]);
array_unshift($types, 'image');
}
$r = '';
foreach ($types as $type) {
$r = self::product_image_url($p, $type, $attrs);
if ($r) {
break;
}
}
}
// 2018-09-05
// «The product image URLs are malformed on Windows»:
// https://github.com/mage2pro/order-notifier/issues/3
return str_replace('\\', '/', str_replace('\//', '/', $r));
}
/**
* 2018-08-11
* @used-by self::remove_objects()
* @used-by \Dfe\OrderNotifier\Payload::address()
* @used-by \Dfe\OrderNotifier\Payload::get()
* @used-by \Dfe\OrderNotifier\Payload::payment()
* @param _DO|mixed[] $v
* @return mixed
*/
private static function remove_objects($v) {return self::clean(array_filter(
is_array($v) ? $v : $v->getData(), function($v) {return
is_object($v) ? false : (!is_array($v) ? true : self::remove_objects($v))
;}
));}
/**
* 2017-09-30
* 2017-11-03
* «Division by zero in mage2pro/core/Tax/lib/main.php on line 11»
* https://github.com/mage2pro/core/issues/42
* It is normal for an order position to have zero price: e.g., in case of free shipping.
* @param float $withTax
* @param float $withoutTax
* @return float
*/
private static function tax_rate($withTax, $withoutTax) {return !$withoutTax ? 0 :
100 * ($withTax - $withoutTax) / $withoutTax
;}
}