Completed
Push — master ( c34bb5...a29fc9 )
by Andrii
04:22
created

FixedDiscount::isAbsolute()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
c 0
b 0
f 0
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\price\SinglePrice;
18
use hiqdev\php\billing\target\Target;
19
use hiqdev\php\billing\type\Type;
20
use hiqdev\php\units\Quantity;
21
use Money\Money;
22
23
/**
24
 * Fixed discount.
25
 *
26
 * @author Andrii Vasyliev <[email protected]>
27
 */
28
class FixedDiscount extends Modifier
29
{
30
    const VALUE = 'value';
31
32 8
    public function __construct($value, array $addons = [])
33
    {
34 8
        parent::__construct($addons);
35 8
        $this->addAddon(self::VALUE, new Discount($value));
36 8
    }
37
38 13
    public function getNext()
39
    {
40 13
        return $this;
41
    }
42
43 5
    public function getValue(ChargeInterface $charge = null): Discount
44
    {
45 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...
46
    }
47
48 3
    public function isAbsolute()
49
    {
50 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

50
        return $this->getAddon(self::VALUE)->/** @scrutinizer ignore-call */ isAbsolute();
Loading history...
51
    }
52
53 5
    public function isRelative()
54
    {
55 5
        return !$this->isAbsolute();
56
    }
57
58 4
    public function calculateSum(ChargeInterface $charge = null): Money
59
    {
60 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

60
        return $this->getValue($charge)->calculateSum(/** @scrutinizer ignore-type */ $charge);
Loading history...
61
    }
62
63 4
    public function buildPrice(Money $sum)
64
    {
65 4
        $type = $this->getType();
66 4
        $target = $this->getTarget();
67 4
        $prepaid = Quantity::items(0);
68
69 4
        return new SinglePrice(null, $type, $target, null, $prepaid, $sum);
70
    }
71
72 4
    public function getType()
73
    {
74 4
        return new Type(Type::ANY, 'discount');
75
    }
76
77 4
    public function getTarget()
78
    {
79 4
        return new Target(Target::ANY, Target::ANY);
80
    }
81
82 4
    public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
83
    {
84 4
        if ($charge === null) {
85
            return [];
86
        }
87
88 4
        $month = $action->getTime()->modify('first day of this month midnight');
89 4
        if (!$this->checkPeriod($month)) {
90
            return [$charge];
91
        }
92
93 4
        $sum = $this->calculateSum($charge);
94 4
        $usage  = Quantity::items(1);
95 4
        $price = $this->buildPrice($sum);
96 4
        $discount = new Charge(null, $action, $price, $usage, $sum->multiply(-1));
97 4
        $reason = $this->getReason();
98 4
        if ($reason) {
99
            $discount->setComment($reason->getValue());
0 ignored issues
show
Bug introduced by
The method getValue() does not exist on hiqdev\php\billing\charge\modifiers\AddonInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to hiqdev\php\billing\charge\modifiers\AddonInterface. ( Ignorable by Annotation )

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

99
            $discount->setComment($reason->/** @scrutinizer ignore-call */ getValue());
Loading history...
100
        }
101
102 4
        return [$charge, $discount];
103
    }
104
}
105