-
Notifications
You must be signed in to change notification settings - Fork 114
/
Checkout.php
385 lines (338 loc) · 11.2 KB
/
Checkout.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
<?php namespace OFFLINE\Mall\Components;
use Auth;
use DB;
use Illuminate\Contracts\Encryption\DecryptException;
use October\Rain\Exception\ValidationException;
use OFFLINE\Mall\Classes\Payments\PaymentGateway;
use OFFLINE\Mall\Classes\Payments\PaymentRedirector;
use OFFLINE\Mall\Classes\Payments\PaymentService;
use OFFLINE\Mall\Components\Cart as CartComponent;
use OFFLINE\Mall\Models\Cart;
use OFFLINE\Mall\Models\GeneralSettings;
use OFFLINE\Mall\Models\Order;
use OFFLINE\Mall\Models\PaymentMethod;
use Redirect;
use Request;
use Session;
use Symfony\Component\HttpFoundation\RedirectResponse;
/**
* The Checkout component orchestrates the checkout process.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Checkout extends MallComponent
{
/**
* The user's cart.
*
* @var Cart
*/
public $cart;
/**
* The error massage received from the PaymentProvider.
*
* @var string
*/
public $paymentError;
/**
* The currently active step.
*
* @var string
*/
public $step;
/**
* The order that was created during checkout.
*
* @var Order
*/
public $order;
/**
* The name of the my account page.
*
* @var string
*/
public $accountPage;
/**
* Google Tag Manager dataLayer code.
*
* @var array
*/
public $dataLayer;
/**
* Backend setting whether shipping should be before payment.
*
* @var bool
*/
public $shippingSelectionBeforePayment = false;
/**
* Component details.
*
* @return array
*/
public function componentDetails()
{
return [
'name' => 'offline.mall::lang.components.checkout.details.name',
'description' => 'offline.mall::lang.components.checkout.details.description',
];
}
/**
* Properties of this component.
*
* @return array
*/
public function defineProperties()
{
return [
'step' => [
'type' => 'dropdown',
'name' => 'offline.mall::lang.components.checkout.properties.step.name',
],
];
}
/**
* Options array for the step dropdown.
*
* @return array
*/
public function getStepOptions()
{
return [
'payment' => trans('offline.mall::lang.components.checkout.steps.payment'),
'shipping' => trans('offline.mall::lang.components.checkout.steps.shipping'),
'confirm' => trans('offline.mall::lang.components.checkout.steps.confirm'),
'failed' => trans('offline.mall::lang.components.checkout.steps.failed'),
'cancelled' => trans('offline.mall::lang.components.checkout.steps.cancelled'),
'done' => trans('offline.mall::lang.components.checkout.steps.done'),
];
}
/**
* The component is initialized.
*
* All child components get added.
*
* @return void
*/
public function init()
{
$this->addComponent(CartComponent::class, 'cart', ['showDiscountApplier' => false]);
if ($this->param('step') === 'confirm') {
$this->addComponent(AddressSelector::class, 'billingAddressSelector', ['type' => 'billing']);
$this->addComponent(AddressSelector::class, 'shippingAddressSelector', ['type' => 'shipping']);
}
if ($this->param('step') === 'shipping') {
$this->addComponent(
ShippingMethodSelector::class,
'shippingMethodSelector',
['skipIfOnlyOneAvailable' => true]
);
}
if ($this->param('step') === 'payment') {
$this->addComponent(PaymentMethodSelector::class, 'paymentMethodSelector', []);
}
$this->setData();
}
/**
* This method sets all variables needed for this component to work.
*
* @return void
*/
protected function setData()
{
$user = Auth::getUser();
if ( ! $user) {
return;
}
$cart = Cart::byUser($user);
if ( ! $cart->payment_method_id) {
$cart->setPaymentMethod(PaymentMethod::getDefault());
}
$this->setVar('cart', $cart);
$paymentMethod = PaymentMethod::find($cart->payment_method_id);
if ( ! $paymentMethod) {
$paymentMethod = PaymentMethod::getDefault();
$cart->setPaymentMethod($paymentMethod);
}
$this->setVar('paymentMethod', $paymentMethod);
$this->setVar('step', $this->property('step'));
$this->setVar('accountPage', GeneralSettings::get('account_page'));
$this->setVar(
'shippingSelectionBeforePayment',
GeneralSettings::get('shipping_selection_before_payment', false)
);
if ($orderId = request()->get('order')) {
$orderId = $this->decode($orderId);
$this->setVar('order', Order::byCustomer($user->customer)->find($orderId));
}
$this->setVar('dataLayer', $this->handleDataLayer());
}
/**
* The component is executed.
*
* @return RedirectResponse|void
* @throws \Cms\Classes\CmsException
*/
public function onRun()
{
// An off-site payment has been completed
if ($type = request()->input('return')) {
return $this->handleOffSiteReturn($type);
}
// If no step is provided or the step is invalid, redirect the user to
// the payment method selection screen.
$step = $this->property('step');
if ( ! $step || ! array_key_exists($step, $this->getStepOptions())) {
$url = $this->stepUrl($this->shippingSelectionBeforePayment ? 'shipping' : 'payment');
return redirect()->to($url);
}
// If an order has been created but something failed we can fetch the paymentError
// from the order's payment logs.
if ($step === 'failed' && $this->order) {
$this->paymentError = optional($this->order->payment_logs->first())->message ?? 'Unknown error';
}
}
/**
* Handle the checkout process.
*
* @return \Symfony\Component\HttpFoundation\Response
* @throws ValidationException
* @throws \Cms\Classes\CmsException
*/
public function onCheckout()
{
$this->setData();
if ($this->cart->payment_method_id === null) {
throw new ValidationException(
[trans('offline.mall::lang.components.checkout.errors.missing_settings')]
);
}
// Safely decrypt and decode any payment data. Fall back to an empty array if something goes wrong.
try {
$paymentData = json_decode(decrypt(session()->get('mall.payment_method.data')), true);
} catch (DecryptException $e) {
$paymentData = [];
}
$paymentMethod = PaymentMethod::findOrFail($this->cart->payment_method_id);
// Grab the PaymentGateway from the Service Container.
$gateway = app(PaymentGateway::class);
$gateway->init($paymentMethod, $paymentData);
// Create the order first.
$order = DB::transaction(function () {
return Order::fromCart($this->cart);
});
// If the order was created successfully proceed with the payment.
$paymentService = new PaymentService(
$gateway,
$order,
$this->page->page->fileName
);
return $paymentService->process();
}
/**
* The user was redirected back to the store from an
* external payment service.
*
* @param string $type
*
* @return \Illuminate\Http\RedirectResponse
* @throws \Cms\Classes\CmsException
*/
protected function handleOffSiteReturn($type)
{
return (new PaymentRedirector($this->page->page->fileName))->handleOffSiteReturn($type);
}
/**
* Return the URL for a specific checkout step.
*
* @param $step
* @param array $params
*
* @return string
*/
public function stepUrl($step, $params = [])
{
$via = false;
if (isset($params['via'])) {
$via = array_pull($params, 'via');
}
$url = $this->controller->pageUrl(
$this->page->page->fileName,
array_merge($params, ['step' => $step])
);
if ( ! $via) {
return $url;
}
return $url . '?' . http_build_query(['via' => $via]);
}
/**
* Generate Google Tag Manager dataLayer code.
*/
private function handleDataLayer()
{
$isCheckout = request()->get('flow') === 'checkout';
if ( ! $this->page->layout->hasComponent('enhancedEcommerceAnalytics')) {
return;
}
$useModel = $this->step === 'done' ? $this->order : $this->cart;
$data = [
'event' => 'checkout',
'ecommerce' => [
'products' => $useModel->products->map(function ($item, $index) {
return $this->getDataLayerProductArray($item);
}),
'checkout' => [
'actionField' => [],
],
],
];
if ($this->step === 'confirm') {
$data['ecommerce']['checkout']['actionField'] = ['step' => 3];
}
if ($this->step === 'done') {
// The "done" step should only count for the initial Checkout flow, not
// later payments that are also redirected to this page.
if ($isCheckout === false) {
return [];
}
unset($data['event'], $data['ecommerce']['checkout']);
$coupon = $this->getDataLayerCoupon();
$data['ecommerce']['purchase'] = [
'actionField' => [
'id' => $this->order->hash_id,
'affiliation' => 'OFFLINE Mall',
'revenue' => $this->order->total_post_taxes,
'tax' => $this->order->total_taxes,
'shipping' => $this->order->total_shipping_post_taxes,
'coupon' => $coupon,
],
];
}
return $data;
}
protected function getDataLayerProductArray($item)
{
$name = $item->product->name;
$variant = optional($item->variant)->name;
$price = $item->total_post_taxes ?? $item->price()->integer;
return [
'id' => $item->prefixedId,
'name' => $name,
'price' => (string)round($price / 100, 2),
'brand' => optional($item->product->brand)->name ?? array_get($item->brand, 'name'),
'category' => $item->product->categories->first()->name,
'variant' => $variant,
'quantity' => $item->quantity,
];
}
protected function getDataLayerCoupon()
{
$coupon = null;
$coupons = $this->order->discounts ?? [];
if (count($coupons)) {
$coupon = implode(',', array_map(function ($coupon) {
return array_get($coupon, 'code');
}, $coupons));
}
return $coupon;
}
}