Completed
Pull Request — master (#72)
by Luke
02:13
created

LaraCart::taxTotal()   B

Complexity

Conditions 5
Paths 2

Size

Total Lines 28
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 6
Bugs 0 Features 0
Metric Value
c 6
b 0
f 0
dl 0
loc 28
rs 8.439
cc 5
eloc 16
nc 2
nop 1
1
<?php
2
3
namespace LukePOLO\LaraCart;
4
5
use Illuminate\Contracts\Events\Dispatcher;
6
use Illuminate\Session\SessionManager;
7
use LukePOLO\LaraCart\Contracts\CouponContract;
8
use LukePOLO\LaraCart\Contracts\LaraCartContract;
9
10
/**
11
 * Class LaraCart
12
 *
13
 * @package LukePOLO\LaraCart
14
 */
15
class LaraCart implements LaraCartContract
16
{
17
    const QTY = 'qty';
18
    const HASH = 'generateCartHash';
19
    const PRICE = 'price';
20
    const SERVICE = 'laracart';
21
    const RANHASH = 'generateRandomCartItemHash';
22
23
    protected $events;
24
    protected $session;
25
26
    public $cart;
27
28
    /**
29
     * LaraCart constructor.
30
     *
31
     * @param SessionManager $session
32
     * @param Dispatcher $events
33
     */
34
    public function __construct(SessionManager $session, Dispatcher $events)
35
    {
36
        $this->session = $session;
37
        $this->events = $events;
38
39
        $this->setInstance($this->session->get('laracart.instance', 'default'));
40
    }
41
42
    /**
43
     * Sets and Gets the instance of the cart in the session we should be using
44
     *
45
     * @param string $instance
46
     *
47
     * @return LaraCart
48
     */
49
    public function setInstance($instance = 'default')
50
    {
51
        $this->get($instance);
52
53
        $this->session->set('laracart.instance', $instance);
54
55
        $this->events->fire('laracart.new');
56
57
        return $this;
58
    }
59
60
    /**
61
     * Gets the instance in the session
62
     *
63
     * @param string $instance
64
     *
65
     * @return $this cart instance
66
     */
67
    public function get($instance = 'default')
68
    {
69
        if (empty($this->cart = $this->session->get(config('laracart.cache_prefix', 'laracart') . '.' . $instance))) {
70
            $this->cart = new Cart($instance);
71
        }
72
73
        return $this;
74
    }
75
76
    /**
77
     * Gets an an attribute from the cart
78
     *
79
     * @param $attribute
80
     * @param $defaultValue
81
     *
82
     * @return mixed
83
     */
84
    public function getAttribute($attribute, $defaultValue = null)
85
    {
86
        return array_get($this->cart->attributes, $attribute, $defaultValue);
87
    }
88
89
    /**
90
     * Gets all the carts attributes
91
     *
92
     * @return mixed
93
     */
94
    public function getAttributes()
95
    {
96
        return $this->cart->attributes;
97
    }
98
99
    /**
100
     * Adds an Attribute to the cart
101
     *
102
     * @param $attribute
103
     * @param $value
104
     */
105
    public function setAttribute($attribute, $value)
106
    {
107
        array_set($this->cart->attributes, $attribute, $value);
108
109
        $this->update();
110
    }
111
112
    /**
113
     * Updates cart session
114
     */
115
    public function update()
116
    {
117
        $this->session->set(config('laracart.cache_prefix', 'laracart') . '.' . $this->cart->instance, $this->cart);
118
119
        $this->events->fire('laracart.update', $this->cart);
120
    }
121
122
    /**
123
     * Removes an attribute from the cart
124
     *
125
     * @param $attribute
126
     */
127
    public function removeAttribute($attribute)
128
    {
129
        array_forget($this->cart->attributes, $attribute);
130
131
        $this->update();
132
    }
133
134
    /**
135
     * Creates a CartItem and then adds it to cart
136
     *
137
     * @param string|int $itemID
138
     * @param null $name
139
     * @param int $qty
140
     * @param string $price
141
     * @param array $options
142
     * @param bool|true $taxable
143
     *
144
     * @return CartItem
145
     */
146
    public function addLine($itemID, $name = null, $qty = 1, $price = '0.00', $options = [], $taxable = true)
147
    {
148
        return $this->add($itemID, $name, $qty, $price, $options, $taxable, true);
149
    }
150
151
    /**
152
     * Creates a CartItem and then adds it to cart
153
     *
154
     * @param $itemID
155
     * @param null $name
156
     * @param int $qty
157
     * @param string $price
158
     * @param array $options
159
     * @param bool|false $taxable
160
     * @param bool|false $lineItem
161
     *
162
     * @return CartItem
163
     */
164
    public function add(
165
        $itemID,
166
        $name = null,
167
        $qty = 1,
168
        $price = '0.00',
169
        $options = [],
170
        $taxable = true,
171
        $lineItem = false
172
    ) {
173
        $item = $this->addItem(
174
            new CartItem(
175
                $itemID,
176
                $name,
177
                $qty,
178
                $price,
179
                $options,
180
                $taxable,
181
                $lineItem
182
            )
183
        );
184
185
        return $this->getItem($item->getHash());
186
    }
187
188
    /**
189
     * Adds the cartItem into the cart session
190
     *
191
     * @param CartItem $cartItem
192
     *
193
     * @return CartItem
194
     */
195
    public function addItem(CartItem $cartItem)
196
    {
197
        $itemHash = $cartItem->generateHash();
198
199
        if ($this->getItem($itemHash)) {
200
            $this->getItem($itemHash)->qty += $cartItem->qty;
0 ignored issues
show
Documentation introduced by
The property qty does not exist on object<LukePOLO\LaraCart\CartItem>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
201
        } else {
202
            $this->cart->items[] = $cartItem;
203
        }
204
205
        $this->events->fire('laracart.addItem', $cartItem);
206
207
        $this->update();
208
209
        return $cartItem;
210
    }
211
212
    /**
213
     * Finds a cartItem based on the itemHash
214
     *
215
     * @param $itemHash
216
     *
217
     * @return CartItem | null
218
     */
219
    public function getItem($itemHash)
220
    {
221
        return array_get($this->getItems(), $itemHash);
222
    }
223
224
    /**
225
     * Gets all the items within the cart
226
     *
227
     * @return array
228
     */
229
    public function getItems()
230
    {
231
        $items = [];
232
        if (isset($this->cart->items) === true) {
233
            foreach ($this->cart->items as $item) {
234
                $items[$item->getHash()] = $item;
235
            }
236
        }
237
238
        return $items;
239
    }
240
241
    /**
242
     * Updates an items attributes
243
     *
244
     * @param $itemHash
245
     * @param $key
246
     * @param $value
247
     *
248
     * @return CartItem
249
     *
250
     * @throws Exceptions\InvalidPrice
251
     * @throws Exceptions\InvalidQuantity
252
     */
253
    public function updateItem($itemHash, $key, $value)
254
    {
255
        if (empty($item = $this->getItem($itemHash)) === false) {
256
            $item->$key = $value;
257
        }
258
259
        $item->generateHash();
260
261
        return $item;
262
    }
263
264
    /**
265
     * Removes a CartItem based on the itemHash
266
     *
267
     * @param $itemHash
268
     */
269
    public function removeItem($itemHash)
270
    {
271
        foreach ($this->cart->items as $itemKey => $item) {
272
            if ($item->getHash() == $itemHash) {
273
                unset($this->cart->items[$itemKey]);
274
                break;
275
            }
276
        }
277
278
        $this->events->fire('laracart.removeItem', $itemHash);
279
    }
280
281
    /**
282
     * Empties the carts items
283
     */
284
    public function emptyCart()
285
    {
286
        unset($this->cart->items);
287
288
        $this->update();
289
290
        $this->events->fire('laracart.empty', $this->cart->instance);
291
    }
292
293
    /**
294
     * Completely destroys cart and anything associated with it
295
     */
296
    public function destroyCart()
297
    {
298
        $instance = $this->cart->instance;
299
300
        $this->session->forget(config('laracart.cache_prefix', 'laracart') . '.' . $instance);
301
302
        $this->setInstance('default');
303
304
        $this->events->fire('laracart.destroy', $instance);
305
    }
306
307
    /**
308
     * Gets the coupons for the current cart
309
     *
310
     * @return array
311
     */
312
    public function getCoupons()
313
    {
314
        return $this->cart->coupons;
315
    }
316
317
    /**
318
     * Finds a specific coupon in the cart
319
     *
320
     * @param $code
321
     * @return mixed
322
     */
323
    public function findCoupon($code)
324
    {
325
        return array_get($this->cart->coupons, $code);
326
    }
327
328
    /**
329
     * Applies a coupon to the cart
330
     *
331
     * @param CouponContract $coupon
332
     */
333
    public function addCoupon(CouponContract $coupon)
334
    {
335
        if (!$this->cart->multipleCoupons) {
336
            $this->cart->coupons = [];
337
        }
338
339
        $this->cart->coupons[$coupon->code] = $coupon;
0 ignored issues
show
Bug introduced by
Accessing code on the interface LukePOLO\LaraCart\Contracts\CouponContract suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
340
341
        $this->update();
342
    }
343
344
    /**
345
     * Removes a coupon in the cart
346
     *
347
     * @param $code
348
     */
349
    public function removeCoupon($code)
350
    {
351
        foreach ($this->getItems() as $item) {
352
            if (isset($item->code) && $item->code == $code) {
353
                $item->code = null;
354
                $item->discount = null;
355
                $item->couponInfo = null;
356
            }
357
        }
358
359
        array_forget($this->cart->coupons, $code);
360
361
        $this->update();
362
    }
363
364
    /**
365
     * Gets a speific fee from the fees array
366
     *
367
     * @param $name
368
     *
369
     * @return mixed
370
     */
371
    public function getFee($name)
372
    {
373
        return array_get($this->cart->fees, $name, new CartFee(null, false));
374
    }
375
376
    /**
377
     * Allows to charge for additional fees that may or may not be taxable
378
     * ex - service fee , delivery fee, tips
379
     *
380
     * @param $name
381
     * @param $amount
382
     * @param bool|false $taxable
383
     * @param array $options
384
     */
385
    public function addFee($name, $amount, $taxable = false, Array $options = [])
386
    {
387
        array_set($this->cart->fees, $name, new CartFee($amount, $taxable, $options));
388
389
        $this->update();
390
    }
391
392
    /**
393
     * Reemoves a fee from the fee array
394
     *
395
     * @param $name
396
     */
397
    public function removeFee($name)
398
    {
399
        array_forget($this->cart->fees, $name);
400
401
        $this->update();
402
    }
403
404
    /**
405
     * Gets the total tax for the cart
406
     *
407
     * @param bool|true $format
408
     *
409
     * @return string
410
     */
411
    public function taxTotal($format = true)
412
    {
413
        $totalTax = 0;
414
415
        $discounted = 0;
416
        $totalDiscount = $this->totalDiscount(false);
417
418
        if ($this->count() != 0) {
419
            foreach ($this->getItems() as $item) {
420
                if ($discounted >= $totalDiscount) {
421
                    $totalTax += $item->tax();
422
                } else {
423
                    $itemPrice = $item->price(false);
424
                    if (($discounted + $itemPrice) > $totalDiscount) {
425
                        $tempItem = clone $item;
426
427
                        $tempItem->price = $totalDiscount - $discounted;
428
429
                        $totalTax += $tempItem->tax();
430
                    }
431
432
                    $discounted += $itemPrice;
433
                }
434
            }
435
        }
436
437
        return $this->formatMoney($totalTax, null, null, $format);
438
    }
439
440
    /**
441
     * Gets the total of the cart with or without tax
442
     *
443
     * @param boolean $format
444
     * @param boolean $withDiscount
445
     *
446
     * @return string
447
     */
448
    public function total($format = true, $withDiscount = true)
449
    {
450
        $total = $this->subTotal(false) + $this->feeTotals(false);
451
452
        if ($withDiscount) {
453
            $total -= $this->totalDiscount(false);
454
        }
455
456
        $total += $this->taxTotal(false);
457
458
        return $this->formatMoney($total, null, null, $format);
459
    }
460
461
    /**
462
     * Gets the subtotal of the cart with or without tax
463
     *
464
     * @param boolean $format
465
     * @param boolean $withDiscount
466
     *
467
     * @return string
468
     */
469
    public function subTotal($format = true, $withDiscount = true)
470
    {
471
        $total = 0;
472
473
        if ($this->count() != 0) {
474
            foreach ($this->getItems() as $item) {
475
                $total += $item->subTotal(false, $withDiscount);
476
            }
477
        }
478
479
        return $this->formatMoney($total, null, null, $format);
480
    }
481
482
    /**
483
     * Get the count based on qty, or number of unique items
484
     *
485
     * @param bool $withItemQty
486
     *
487
     * @return int
488
     */
489
    public function count($withItemQty = true)
490
    {
491
        $count = 0;
492
493
        foreach ($this->getItems() as $item) {
494
            if ($withItemQty) {
495
                $count += $item->qty;
496
            } else {
497
                $count++;
498
            }
499
        }
500
501
        return $count;
502
    }
503
504
    /**
505
     *
506
     * Formats the number into a money format based on the locale and international formats
507
     *
508
     * @param $number
509
     * @param $locale
510
     * @param $internationalFormat
511
     * @param $format
512
     *
513
     * @return string
514
     */
515
    public static function formatMoney($number, $locale = null, $internationalFormat = null, $format = true)
516
    {
517
        $number = number_format($number, 2, '.', '');
518
519
        if ($format) {
520
            setlocale(LC_MONETARY, empty($locale) ? config('laracart.locale', 'en_US.UTF-8') : $locale);
521
522
            if (empty($internationalFormat) === true) {
523
                $internationalFormat = config('laracart.international_format', false);
524
            }
525
526
            $number = money_format($internationalFormat ? '%i' : '%n', $number);
527
        }
528
529
        return $number;
530
    }
531
532
    /**
533
     * Gets all the fee totals
534
     *
535
     * @param boolean $format
536
     *
537
     * @return string
538
     */
539
    public function feeTotals($format = true)
540
    {
541
        $feeTotal = 0;
542
543
        foreach ($this->getFees() as $fee) {
544
            $feeTotal += $fee->amount;
545
            if ($fee->taxable) {
546
                $feeTotal += $fee->amount * $this->cart->tax;
547
            }
548
        }
549
550
        return $this->formatMoney($feeTotal, null, null, $format);
551
    }
552
553
    /**
554
     * Gets all the fees on the cart object
555
     *
556
     * @return mixed
557
     */
558
    public function getFees()
559
    {
560
        return $this->cart->fees;
561
    }
562
563
    /**
564
     * Gets the total amount discounted
565
     *
566
     * @param boolean $format
567
     *
568
     * @return string
569
     */
570
    public function totalDiscount($format = true)
571
    {
572
        $total = 0;
573
574
        foreach ($this->cart->coupons as $coupon) {
575
            $total += $coupon->discount();
576
        }
577
578
        return $this->formatMoney($total, null, null, $format);
579
    }
580
}
581