Resource::isPeriodic() - Code Metrics - Inspection of "Implemented VDS tariffs management" - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 018a2f...b87a46 )

by Dmitry

created 2016-09-07 14:57 UTC

Resource::isPeriodic() A

↳ Parent: Resource

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?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-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\models;

use hipanel\modules\finance\models\decorators\AbstractResourceDecorator;
use hipanel\modules\stock\models\Part;
use Yii;
use yii\base\InvalidConfigException;

/**
 * @property Tariff $tariff
 */
class Resource extends \hipanel\base\Model
{
    use \hipanel\base\ModelTrait;

    /** @var  AbstractResourceDecorator */
    protected $decorator;

    /** @inheritdoc */
    public static $i18nDictionary = 'hipanel/finance/tariff';

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [['id', 'tariff_id', 'object_id', 'type_id', 'unit_id', 'currency_id', 'hardlim'], 'integer'],
            [['type', 'ftype', 'unit', 'unit_factor', 'currency'], 'safe'],
            [['price', 'fee', 'quantity', 'discount'], 'number'],

            [['object_id', 'type_id'], 'integer', 'on' => ['create', 'update']],
            [['type'], 'safe', 'on' => ['create', 'update']],
            [['price'], 'number', 'on' => ['create', 'update']],
            'create-required' => [['object_id', 'price'], 'required', 'on' => ['create', 'update']],
        ];
    }

    public function getTariff()
    {
        return $this->hasOne(Tariff::class, ['id' => 'tariff_id'])->inverseOf('resources');
    }

    public function getPart()
    {
        if (!Yii::getAlias('@part', false)) {
            throw new InvalidConfigException('Stock module is a must to retrieve resource parts');
        }

        return $this->hasOne(Part::class, ['object_id' => 'id']);
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return $this->mergeAttributeLabels([
            'price' => Yii::t('hipanel/finance/tariff', 'Price per period')
        ]);
    }

    public function isTypeCorrect()
    {
        return isset($this->getTypes()[$this->type]);
<?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.");
        }
    }

}
    }

    public function getTypes()
    {
        return [];
    }

    public function isPeriodic()
    {
        return $this->type === 'periodic';
<?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.");
        }
    }

}
    }

    public function decorator()
    {
        throw new InvalidConfigException('Method "decorator" is not available for class Resource');
    }
}


1			<?php
2
3			/*
4			* Finance module for HiPanel
5			*
6			* @link https://github.com/hiqdev/hipanel-module-finance
7			* @package hipanel-module-finance
8			* @license BSD-3-Clause
9			* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10			*/
11
12			namespace hipanel\modules\finance\models;
13
14			use hipanel\modules\finance\models\decorators\AbstractResourceDecorator;
15			use hipanel\modules\stock\models\Part;
16			use Yii;
17			use yii\base\InvalidConfigException;
18
19			/**
20			* @property Tariff $tariff
21			*/
22			class Resource extends \hipanel\base\Model
23			{
24			use \hipanel\base\ModelTrait;
25
26			/** @var AbstractResourceDecorator */
27			protected $decorator;
28
29			/** @inheritdoc */
30			public static $i18nDictionary = 'hipanel/finance/tariff';
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function rules()
36			{
37			return [
38			[['id', 'tariff_id', 'object_id', 'type_id', 'unit_id', 'currency_id', 'hardlim'], 'integer'],
39			[['type', 'ftype', 'unit', 'unit_factor', 'currency'], 'safe'],
40			[['price', 'fee', 'quantity', 'discount'], 'number'],
41
42			[['object_id', 'type_id'], 'integer', 'on' => ['create', 'update']],
43			[['type'], 'safe', 'on' => ['create', 'update']],
44			[['price'], 'number', 'on' => ['create', 'update']],
45			'create-required' => [['object_id', 'price'], 'required', 'on' => ['create', 'update']],
46			];
47			}
48
49			public function getTariff()
50			{
51			return $this->hasOne(Tariff::class, ['id' => 'tariff_id'])->inverseOf('resources');
52			}
53
54			public function getPart()
55			{
56			if (!Yii::getAlias('@part', false)) {
57			throw new InvalidConfigException('Stock module is a must to retrieve resource parts');
58			}
59
60			return $this->hasOne(Part::class, ['object_id' => 'id']);
61			}
62
63			/**
64			* {@inheritdoc}
65			*/
66			public function attributeLabels()
67			{
68			return $this->mergeAttributeLabels([
69			'price' => Yii::t('hipanel/finance/tariff', 'Price per period')
70			]);
71			}
72
73			public function isTypeCorrect()
74			{
75			return isset($this->getTypes()[$this->type]);
			0 ignored issues – show Documentation introduced 2016-08-25 15:25 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<hipanel\modules\finance\models\Resource>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
76			}
77
78			public function getTypes()
79			{
80			return [];
81			}
82
83			public function isPeriodic()
84			{
85			return $this->type === 'periodic';
			0 ignored issues – show Documentation introduced 2016-09-07 15:07 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<hipanel\modules\finance\models\Resource>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
86			}
87
88			public function decorator()
89			{
90			throw new InvalidConfigException('Method "decorator" is not available for class Resource');
91			}
92			}
93

hiqdev / hipanel-module-finance

Push — master ( 018a2f...b87a46 )

Resource::isPeriodic() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like