Completed
Push — master ( 4b3a6a...ccebfa )
by Dmitry
04:39
created

CertificatePrice::getMoneyForPeriod()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 0
Metric Value
dl 0
loc 8
ccs 0
cts 7
cp 0
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 1
crap 6
1
<?php
2
/**
3
 * Finance module for HiPanel
4
 *
5
 * @link      https://github.com/hiqdev/hipanel-module-finance
6
 * @package   hipanel-module-finance
7
 * @license   BSD-3-Clause
8
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
9
 */
10
11
namespace hipanel\modules\finance\models;
12
13
use hipanel\base\ModelTrait;
14
use Money\Currencies\ISOCurrencies;
15
use Money\Currency;
0 ignored issues
show
Bug introduced by pkolomiy
This use statement conflicts with another class in this namespace, hipanel\modules\finance\models\Currency.

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...
16
use Money\Formatter\DecimalMoneyFormatter;
17
use Money\Money;
18
use Money\Parser\DecimalMoneyParser;
19
use Yii;
20
use yii\behaviors\AttributeTypecastBehavior;
21
use yii\validators\NumberValidator;
22
23
/**
24
 * @property array $sums
25
 */
26
class CertificatePrice extends Price
27
{
28
    use ModelTrait;
29
30
    public const TYPE_CERT_PURCHASE = 'certificate,certificate_purchase';
31
    public const TYPE_CERT_RENEWAL = 'certificate,certificate_renewal';
32
33
    /**
34
     * @var DecimalMoneyFormatter
35
     */
36
    private $moneyFormatter;
37
38
    /**
39
     * @var DecimalMoneyParser
40
     */
41
    private $moneyParser;
42
43
    public function __construct(array $config = [])
44
    {
45
        parent::__construct($config);
46
        $this->moneyFormatter = new DecimalMoneyFormatter(new ISOCurrencies());
47
        $this->moneyParser = new DecimalMoneyParser(new ISOCurrencies());
48
    }
49
50
    public static function tableName()
51
    {
52
        return 'price';
53
    }
54
55
    public function behaviors()
56
    {
57
        return [
58
            'typecastAfterFind' => [
59
                'class' => AttributeTypecastBehavior::class,
60
                'attributeTypes' => [
61
                    'sums' => function ($sums) {
62
                        foreach ($sums as $key => $value) {
63
                            $sums[$key] = new Money($value, new Currency(strtoupper($this->currency)));
64
                        }
65
66
                        return $sums;
67
                    }, ],
68
                'typecastAfterFind' => true,
69
                'typecastAfterValidate' => false,
70
                'typecastBeforeSave' => false,
71
            ],
72
            'typecastBeforeSave' => [
73
                'class' => AttributeTypecastBehavior::class,
74
                'attributeTypes' => [
75
                    'sums' => function ($sums) {
76
                        foreach ($sums as $key => $value) {
77
                            $sums[$key] = $this->moneyParser
78
                                ->parse($value, strtoupper($this->currency))
79
                                ->getAmount();
80
                        }
81
82
                        return $sums;
83
                    }, ],
84
                'typecastAfterFind' => false,
85
                'typecastAfterValidate' => false,
86
                'typecastBeforeSave' => true,
87
            ],
88
        ];
89
    }
90
91
    public function rules()
92
    {
93
        $rules = parent::rules();
94
        $rules['create-required'] = [
95
            ['object_id'],
96
            'required',
97
            'on' => ['create', 'update'],
98
            'when' => function ($model) {
99
                /** @var self $model */
100
                return $model->isTypeCorrect();
0 ignored issues
show
Documentation Bug introduced by pkolomiy
The method isTypeCorrect does not exist on object<hipanel\modules\f...nce\models\Calculation>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
101
            },
102
        ];
103
        $rules[] = [['certificateType'], 'safe'];
104
        $rules[] = [['sums'], 'validatePrices', 'on' => ['create', 'update']];
105
        $rules[] = [['sums'], 'number', 'min' => 0, 'when' => function () {
106
            return false;
107
        }];
108
        $rules[] = [['sums'], 'each', 'rule' => ['number', 'min' => 0]];
109
110
        return $rules;
111
    }
112
113
    /**
114
     * @return bool
115
     */
116
    public function isTypeCorrect(): bool
117
    {
118
        return isset($this->getTypes()[$this->type]);
119
    }
120
121
    /**
122
     * @return array
123
     */
124
    public static function getPeriods()
125
    {
126
        return [
127
            1 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 1]),
128
            2 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 2]),
129
        ];
130
    }
131
132
    /**
133
     * @return array
134
     */
135
    public function getAvailablePeriods()
136
    {
137
        $periods = [];
138
        foreach ([1, 2] as $period) {
139
            if ($this->hasPriceForPeriod($period)) {
140
                $periods[$period] = Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => $period]);
141
            }
142
        }
143
144
        return $periods;
145
    }
146
147
    /**
148
     * @param int $period
149
     * @return string|null
150
     */
151
    public function getPriceForPeriod(int $period)
152
    {
153
        return $this->moneyFormatter->format($this->getMoneyForPeriod($period));
154
    }
155
156
    public function getMoneyForPeriod(int $period): ?Money
157
    {
158
        if (!$this->hasPriceForPeriod($period)) {
159
            return null;
160
        }
161
162
        return $this->sums[$period];
163
    }
164
165
    /**
166
     * @param int $period
167
     * @return bool
168
     */
169
    public function hasPriceForPeriod(int $period)
170
    {
171
        return !empty($this->sums[$period]);
172
    }
173
174
    public function validatePrices(): bool
175
    {
176
        $periods = $this->getPeriods();
177
        $validator = new NumberValidator();
178
179
        foreach (array_keys($periods) as $period) {
180
            $validation = $validator->validate($this->sums[$period]);
181
            if ($validation === false) {
182
                unset($this->sums[$period]);
183
            }
184
        }
185
186
        return true;
187
    }
188
189
    /**
190
     * @return array
191
     */
192
    public static function getTypes()
193
    {
194
        return [
195
            static::TYPE_CERT_PURCHASE => Yii::t('hipanel:finance:tariff', 'Purchase'),
196
            static::TYPE_CERT_RENEWAL => Yii::t('hipanel:finance:tariff', 'Renewal'),
197
        ];
198
    }
199
}
200