Calculation - Code Metrics - Inspection of "Implemented cart finishing with currency convertin..." - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 753652...d0e0e5 )

by Dmitry

created 2019-10-04 16:18 UTC

Calculation A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	13
lcom	1
cbo	5
dl	0
loc	81
ccs	0
cts	49
cp	0
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	tableName()	4	1
A	init()	16	5
A	getValue()	5	1
A	getValueConverted()	5	1
A	forCurrency()	13	3
A	rules()	8	1
A	synchronize()	4	1

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\models;

use Yii;
use yii\base\InvalidParamException;

/**
 * Class Calculation.
 *
 *
 * @property-read Value[] value
 * @property-read Value[] valueConverted
 */
class Calculation extends \hipanel\base\Model
{
    use \hipanel\base\ModelTrait;

    /** {@inheritdoc} */
    public static function tableName()
    {
        return 'action';
    }

    /** {@inheritdoc} */
    public function init()
    {
        if (!isset($this->seller)) {
            if (Yii::$app->user->getIsGuest()) {
                $this->seller = Yii::$app->params['user.seller'];
<?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.");
        }
    }

}
            } else {
                $this->seller = Yii::$app->user->identity->seller;
<?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.");
        }
    }

}
            }
        }

        if (!isset($this->client) && !Yii::$app->user->getIsGuest()) {
            $this->client = Yii::$app->user->identity->username;
<?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.");
        }
    }

}
        }

        $this->synchronize();
    }

    public function getValue()
    {
        // ['tariff_id' => 'currency'] is a dumb relation condition and does not make any sense
        return $this->hasMany(Value::class, ['tariff_id' => 'currency'])->indexBy('currency');
    }

    public function getValueConverted()
    {
        // ['tariff_id' => 'currency'] is a dumb relation condition and does not make any sense
        return $this->hasMany(Value::class, ['tariff_id' => 'currency'])->indexBy('currency');
    }

    /**
     * @param string $currency
     *
     * @throws InvalidParamException when the $currency is not calculated
     * @return Value
     */
    public function forCurrency($currency)
    {
        if (isset($this->value[$currency])) {
            return $this->value[$currency];
        }
        if (!empty($this->value)) {
            return reset($this->value);

        }
        Yii::warning('Value for currency $currency was not found. Using fake free value. Most probably, tariff is free', __METHOD__);

        return new Value(['value' => 0, 'price' => 0]);

    }

    /** {@inheritdoc} */
    public function rules()
    {
        return [
            [['object', 'seller', 'client', 'type', 'currency', 'item'], 'safe'],
            [['amount'], 'number'],
            [['tariff_id', 'calculation_id'], 'integer'],
        ];
    }

    /**
     * Synchronises the model to represent actual state of [[position]]
     * The method must update values, that affects the calculation and
     * can be changed in cart without position re-adding.
     * For example: quantity.
     */
    public function synchronize()
    {
        return true;
    }
}


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 2016-06-24 07:57 UTC by Report Bug Copy Issue Report 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 2016-09-20 12:55 UTC by Report Bug Copy Issue Report 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 2016-06-24 07:57 UTC by Report Bug Copy Issue Report 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 2019-10-04 16:23 UTC by Report Bug Copy Issue Report 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]);
80
81			}
82
83			/** {@inheritdoc} */
84			public function rules()
85			{
86			return [
87			[['object', 'seller', 'client', 'type', 'currency', 'item'], 'safe'],
88			[['amount'], 'number'],
89			[['tariff_id', 'calculation_id'], 'integer'],
90			];
91			}
92
93			/**
94			* Synchronises the model to represent actual state of [[position]]
95			* The method must update values, that affects the calculation and
96			* can be changed in cart without position re-adding.
97			* For example: quantity.
98			*/
99			public function synchronize()
100			{
101			return true;
102			}
103			}
104

hiqdev / hipanel-module-finance

Push — master ( 753652...d0e0e5 )

Calculation A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Duplication Side-by-Side

Filter issues like