Calculation::init()   A
last analyzed

Complexity

Conditions 5
Paths 6

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 30

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 16
ccs 0
cts 14
cp 0
rs 9.4222
cc 5
nc 6
nop 0
crap 30
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 Yii;
14
use yii\base\InvalidParamException;
15
16
/**
17
 * Class Calculation.
18
 *
19
 *
20
 * @property-read Value[] value
21
 * @property-read Value[] valueConverted
22
 */
23
class Calculation extends \hipanel\base\Model
24
{
25
    use \hipanel\base\ModelTrait;
26
27
    /** {@inheritdoc} */
28
    public static function tableName()
29
    {
30
        return 'action';
31
    }
32
33
    /** {@inheritdoc} */
34
    public function init()
35
    {
36
        if (!isset($this->seller)) {
37
            if (Yii::$app->user->getIsGuest()) {
38
                $this->seller = Yii::$app->params['user.seller'];
0 ignored issues
show
Documentation introduced by
The property seller does not exist on object<hipanel\modules\f...nce\models\Calculation>. 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...
39
            } else {
40
                $this->seller = Yii::$app->user->identity->seller;
0 ignored issues
show
Documentation introduced by
The property seller does not exist on object<hipanel\modules\f...nce\models\Calculation>. 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...
41
            }
42
        }
43
44
        if (!isset($this->client) && !Yii::$app->user->getIsGuest()) {
45
            $this->client = Yii::$app->user->identity->username;
0 ignored issues
show
Documentation introduced by
The property client does not exist on object<hipanel\modules\f...nce\models\Calculation>. 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...
46
        }
47
48
        $this->synchronize();
49
    }
50
51
    public function getValue()
52
    {
53
        // ['tariff_id' => 'currency'] is a dumb relation condition and does not make any sense
54
        return $this->hasMany(Value::class, ['tariff_id' => 'currency'])->indexBy('currency');
55
    }
56
57
    public function getValueConverted()
58
    {
59
        // ['tariff_id' => 'currency'] is a dumb relation condition and does not make any sense
60
        return $this->hasMany(Value::class, ['tariff_id' => 'currency'])->indexBy('currency');
61
    }
62
63
    /**
64
     * @param string $currency
65
     *
66
     * @throws InvalidParamException when the $currency is not calculated
67
     * @return Value
68
     */
69
    public function forCurrency($currency)
70
    {
71
        if (isset($this->value[$currency])) {
72
            return $this->value[$currency];
73
        }
74
        if (!empty($this->value)) {
75
            return reset($this->value);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The expression reset($this->value); of type hipanel\modules\finance\models\Value|false adds false to the return on line 75 which is incompatible with the return type documented by hipanel\modules\finance\...alculation::forCurrency of type hipanel\modules\finance\models\Value. It seems like you forgot to handle an error condition.
Loading history...
76
        }
77
        Yii::warning('Value for currency $currency was not found. Using fake free value. Most probably, tariff is free', __METHOD__);
78
79
        return new Value(['value' => 0, 'price' => 0, 'currency' => $currency]);
80
    }
81
82
    /** {@inheritdoc} */
83
    public function rules()
84
    {
85
        return [
86
            [['object', 'seller', 'client', 'type', 'currency', 'item'], 'safe'],
87
            [['amount'], 'number'],
88
            [['tariff_id', 'calculation_id'], 'integer'],
89
        ];
90
    }
91
92
    /**
93
     * Synchronises the model to represent actual state of [[position]]
94
     * The method must update values, that affects the calculation and
95
     * can be changed in cart without position re-adding.
96
     * For example: quantity.
97
     */
98
    public function synchronize()
99
    {
100
        return true;
101
    }
102
}
103