CertificateResource::getPriceForPeriod() - Code Metrics - Inspection of "Refactored certificate prices management" - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 920b36...b9da09 )

by Dmitry

created 2017-06-20 15:42 UTC

CertificateResource::getPriceForPeriod() A

↳ Parent: CertificateResource

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	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-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\models;

use hipanel\base\ModelTrait;
use Yii;
use yii\base\InvalidConfigException;
use yii\validators\NumberValidator;

/**
 * Class CertificateResource
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class CertificateResource extends Resource
{
    use ModelTrait;

    public static function tableName()
    {
        return 'resource';
    }

    const TYPE_CERT_REGISTRATION = 'certificate_purchase';
    const TYPE_CERT_RENEW = 'certificate_renew';

    public function rules()

    {
        $rules = parent::rules();
        $rules['create-required'] = [
            ['object_id'],
            'required',
            'on' => ['create', 'update'],
            'when' => function ($model) {
                /** @var self $model */
                return $model->isTypeCorrect();
            },
        ];
        $rules[] = [['certificateType'], 'safe'];
        $rules[] = [['data'], 'validatePrices', 'on' => ['create', 'update']];

        return $rules;
    }

    /**
     * @return array
     */
    public static function getPeriods()
    {
        return [
            1 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 1]),
            2 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 2]),
            3 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 3]),
        ];
    }

    public function getPriceForPeriod($period)
    {
        if (!isset(self::getPeriods()[$period])) {
            throw new InvalidConfigException('Period ' . $period . ' is not available');
        }

        return $this->data['prices'][$period];
<?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 validatePrices()
    {
        $periods = $this->getPeriods();
        $validator = new NumberValidator();

        foreach (array_keys($periods) as $period) {
            $validation = $validator->validate($this->data['prices'][$period]);
<?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 ($validation === false) {
                unset($this->data['prices'][$period]);
            }
        }

        $this->data = ['prices' => $this->data['prices']];
<?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.");
        }
    }

}

        return true;
    }

    /**
     * @return array
     */
    public function getTypes()

    {
        return [
            static::TYPE_CERT_REGISTRATION => Yii::t('hipanel:finance:tariff', 'Registration'),
            static::TYPE_CERT_RENEW => Yii::t('hipanel:finance:tariff', 'Renewal'),
        ];
    }
}


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-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hipanel\modules\finance\models;
12
13		use hipanel\base\ModelTrait;
14		use Yii;
15		use yii\base\InvalidConfigException;
16		use yii\validators\NumberValidator;
17
18		/**
19		* Class CertificateResource
20		*
21		* @author Dmytro Naumenko <[email protected]>
22		*/
23		class CertificateResource extends Resource
24		{
25		use ModelTrait;
26
27		public static function tableName()
28		{
29		return 'resource';
30		}
31
32		const TYPE_CERT_REGISTRATION = 'certificate_purchase';
33		const TYPE_CERT_RENEW = 'certificate_renew';
34
35	View Code Duplication	public function rules()
		0 ignored issues – show Duplication introduced 2016-09-07 15:07 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		{
37		$rules = parent::rules();
38		$rules['create-required'] = [
39		['object_id'],
40		'required',
41		'on' => ['create', 'update'],
42		'when' => function ($model) {
43		/** @var self $model */
44		return $model->isTypeCorrect();
45		},
46		];
47		$rules[] = [['certificateType'], 'safe'];
48		$rules[] = [['data'], 'validatePrices', 'on' => ['create', 'update']];
49
50		return $rules;
51		}
52
53		/**
54		* @return array
55		*/
56		public static function getPeriods()
57		{
58		return [
59		1 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 1]),
60		2 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 2]),
61		3 => Yii::t('hipanel:finance:tariff', '{n, plural, one{# year} other{# years}}', ['n' => 3]),
62		];
63		}
64
65		public function getPriceForPeriod($period)
66		{
67		if (!isset(self::getPeriods()[$period])) {
68		throw new InvalidConfigException('Period ' . $period . ' is not available');
69		}
70
71		return $this->data['prices'][$period];
		0 ignored issues – show Documentation introduced 2017-06-20 15:47 UTC by Report Bug Copy Issue Report The property `data` does not exist on `object<hipanel\modules\f...ls\CertificateResource>`. 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...
72		}
73
74		public function validatePrices()
75		{
76		$periods = $this->getPeriods();
77		$validator = new NumberValidator();
78
79		foreach (array_keys($periods) as $period) {
80		$validation = $validator->validate($this->data['prices'][$period]);
		0 ignored issues – show Documentation introduced 2017-06-20 15:47 UTC by Report Bug Copy Issue Report The property `data` does not exist on `object<hipanel\modules\f...ls\CertificateResource>`. 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...
81		if ($validation === false) {
82		unset($this->data['prices'][$period]);
83		}
84		}
85
86		$this->data = ['prices' => $this->data['prices']];
		0 ignored issues – show Documentation introduced 2017-06-20 15:47 UTC by Report Bug Copy Issue Report The property `data` does not exist on `object<hipanel\modules\f...ls\CertificateResource>`. 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... Documentation introduced 2017-06-20 15:47 UTC by Report Bug Copy Issue Report The property `data` does not exist on `object<hipanel\modules\f...ls\CertificateResource>`. 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...
87
88		return true;
89		}
90
91		/**
92		* @return array
93		*/
94	View Code Duplication	public function getTypes()
		0 ignored issues – show Duplication introduced 2017-06-20 10:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		{
96		return [
97		static::TYPE_CERT_REGISTRATION => Yii::t('hipanel:finance:tariff', 'Registration'),
98		static::TYPE_CERT_RENEW => Yii::t('hipanel:finance:tariff', 'Renewal'),
99		];
100		}
101		}
102

hiqdev / hipanel-module-finance

Push — master ( 920b36...b9da09 )

CertificateResource::getPriceForPeriod() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like