Completed
Push — master ( e83455...d2af9f )
by Andrii
06:07 queued 04:16
created

FixedDiscount   A

Complexity

Total Complexity 12

Size/Duplication

Total Lines 69
Duplicated Lines 0 %

Test Coverage

Coverage 91.18%

Importance

Changes 0
Metric Value
eloc 28
dl 0
loc 69
ccs 31
cts 34
cp 0.9118
rs 10
c 0
b 0
f 0
wmc 12

8 Methods

Rating   Name   Duplication   Size   Complexity  
A isRelative() 0 3 1
A getNext() 0 3 1
A getType() 0 6 2
A __construct() 0 4 1
A getValue() 0 3 1
A isAbsolute() 0 3 1
A calculateSum() 0 3 1
A modifyCharge() 0 26 4
1
<?php
2
/**
3
 * PHP Billing Library
4
 *
5
 * @link      https://github.com/hiqdev/php-billing
6
 * @package   php-billing
7
 * @license   BSD-3-Clause
8
 * @copyright Copyright (c) 2017-2018, HiQDev (http://hiqdev.com/)
9
 */
10
11
namespace hiqdev\php\billing\charge\modifiers;
12
13
use hiqdev\php\billing\action\ActionInterface;
14
use hiqdev\php\billing\charge\Charge;
15
use hiqdev\php\billing\charge\ChargeInterface;
16
use hiqdev\php\billing\charge\modifiers\addons\Discount;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, hiqdev\php\billing\charge\modifiers\Discount. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/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 before OtherDir/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:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
17
use hiqdev\php\billing\type\Type;
18
use hiqdev\php\units\Quantity;
19
use Money\Money;
20
21
/**
22
 * Fixed discount.
23
 *
24
 * @author Andrii Vasyliev <[email protected]>
25
 */
26
class FixedDiscount extends Modifier
27
{
28
    const VALUE = 'value';
29
30 13
    public function __construct($value, array $addons = [])
31
    {
32 13
        parent::__construct($addons);
33 13
        $this->addAddon(self::VALUE, new Discount($value));
34 13
    }
35
36 13
    public function getNext()
37
    {
38 13
        return $this;
39
    }
40
41 5
    public function getValue(ChargeInterface $charge = null): Discount
42
    {
43 5
        return $this->getAddon(self::VALUE);
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this->getAddon(self::VALUE) returns the type null which is incompatible with the type-hinted return hiqdev\php\billing\charg...difiers\addons\Discount.
Loading history...
44
    }
45
46 3
    public function isAbsolute()
47
    {
48 3
        return $this->getAddon(self::VALUE)->isAbsolute();
0 ignored issues
show
Bug introduced by
The method isAbsolute() does not exist on hiqdev\php\billing\charge\modifiers\AddonInterface. It seems like you code against a sub-type of hiqdev\php\billing\charge\modifiers\AddonInterface such as hiqdev\php\billing\charg...difiers\addons\Discount. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

48
        return $this->getAddon(self::VALUE)->/** @scrutinizer ignore-call */ isAbsolute();
Loading history...
49
    }
50
51 5
    public function isRelative()
52
    {
53 5
        return !$this->isAbsolute();
54
    }
55
56 4
    public function calculateSum(ChargeInterface $charge = null): Money
57
    {
58 4
        return $this->getValue($charge)->calculateSum($charge);
0 ignored issues
show
Bug introduced by
It seems like $charge can also be of type null; however, parameter $charge of hiqdev\php\billing\charg...iscount::calculateSum() does only seem to accept hiqdev\php\billing\charge\ChargeInterface, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

58
        return $this->getValue($charge)->calculateSum(/** @scrutinizer ignore-type */ $charge);
Loading history...
59
    }
60
61 4
    private function getType()
62
    {
63 4
        $chargeTypeAddon = $this->getChargeType();
64
65 4
        $type = $chargeTypeAddon ? $chargeTypeAddon->getValue() : 'discount,discount';
0 ignored issues
show
introduced by
$chargeTypeAddon is of type hiqdev\php\billing\charg...fiers\addons\ChargeType, thus it always evaluated to true.
Loading history...
66
        return new Type(Type::ANY, $type);
67 4
    }
68
69
    public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
70 4
    {
71
        if ($charge === null) {
72 4
            return [];
73
        }
74
75
        $month = $action->getTime()->modify('first day of this month midnight');
76 4
        if (!$this->checkPeriod($month)) {
77 4
            return [$charge];
78
        }
79
80
        $sum    = $this->calculateSum($charge)->multiply(-1);
81 4
        $usage  = Quantity::create('items', 1);
82 4
        $type   = $this->getType();
83 4
        $price  = $charge->getPrice();
84 4
        $target = $charge->getTarget();
85 4
86
        $discount = new Charge(null, $type, $target, $action, $price, $usage, $sum);
87 4
        $discount->setParent($charge);
88 4
89
        $reason = $this->getReason();
90 4
        if ($reason) {
0 ignored issues
show
introduced by
$reason is of type hiqdev\php\billing\charge\modifiers\addons\Reason, thus it always evaluated to true.
Loading history...
91 4
            $discount->setComment($reason->getValue());
92
        }
93
94
        return [$charge, $discount];
95 4
    }
96
}
97