AbstractTariffManager - Code Metrics - Inspection of "Modified tariffs management code to follow module..." - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5a5e4b...77b1bb )

by Dmitry

created 2016-09-13 16:36 UTC

AbstractTariffManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	10
lcom	1
cbo	8
dl	0
loc	110
ccs	0
cts	47
cp	0
rs	10
c	1
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	init()	5	1
A	buildForm()	8	1
A	getFormOptions()	4	1
A	findBaseTariffs()	15	2
A	getType()	4	1
A	calculator()	10	2
A	calculation()	4	1
A	setTariff()	4	1

<?php

namespace hipanel\modules\finance\logic;

use hipanel\modules\finance\forms\AbstractTariffForm;
use hipanel\modules\finance\models\Tariff;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Object;
use yii\helpers\ArrayHelper;
use yii\web\ForbiddenHttpException;

abstract class AbstractTariffManager extends Object
{
    /**
     * @var Tariff[] they array of all available base tariffs
     * @see findBaseTariffs()
     */
    protected $baseTariffs;

    /**
     * @var AbstractTariffForm
     */
    public $form;

    /**
     * @var array options used to build [[form]]
     * @see buildForm()
     */
    public $formOptions = [];

    /**
     * @var string
     */
    public $scenario;

    /**
     * @var Tariff The actual tariff
     */
    protected $tariff;

    /**
     * @var string The type used to find base tariff
     */
    protected $type;
    
    public function init()
    {
        $this->findBaseTariffs();
        $this->buildForm();
    }

    /**
     * Fills [[form]] property with a proper [[AbstractTariffForm]] object
     */
    protected function buildForm()
    {
        $this->form = Yii::createObject(array_merge([
            'scenario' => $this->scenario,
            'baseTariffs' => $this->baseTariffs,
            'tariff' => $this->tariff
        ], $this->getFormOptions()));
    }

    protected function getFormOptions()
    {
        return $this->formOptions;
    }

    protected function findBaseTariffs()
    {
        $availableTariffs = Tariff::find(['scenario' => 'get-available-info'])
            ->andFilterWhere(['type' => $this->type])
            ->all();

        if (empty($availableTariffs)) {
            throw new ForbiddenHttpException('No available tariffs found');
        }

        $this->baseTariffs = Tariff::find()
            ->where(['id' => ArrayHelper::getColumn($availableTariffs, 'id')])
            ->details()
            ->all();
    }

    public function getType()
    {
        return $this->type;
    }

    /**
     * @var TariffCalculator
     */
    protected $_calculator;

    /**
     * @return TariffCalculator
     */
    protected function calculator()
    {
        if (isset($this->_calculator)) {
            return $this->_calculator;
        }

        $this->_calculator = new TariffCalculator($this->tariff);

        return $this->_calculator;
    }

    public function calculation()
    {
        return $this->calculator()->getCalculation($this->tariff->id)->forCurrency($this->tariff->currency);
<?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.");
        }
    }

}
    }

    /**
     * @param Tariff $tariff
     */
    public function setTariff($tariff)
    {
        $this->tariff = $tariff;
    }
}


1			<?php
2
3			namespace hipanel\modules\finance\logic;
4
5			use hipanel\modules\finance\forms\AbstractTariffForm;
6			use hipanel\modules\finance\models\Tariff;
7			use Yii;
8			use yii\base\InvalidConfigException;
9			use yii\base\Object;
10			use yii\helpers\ArrayHelper;
11			use yii\web\ForbiddenHttpException;
12
13			abstract class AbstractTariffManager extends Object
14			{
15			/**
16			* @var Tariff[] they array of all available base tariffs
17			* @see findBaseTariffs()
18			*/
19			protected $baseTariffs;
20
21			/**
22			* @var AbstractTariffForm
23			*/
24			public $form;
25
26			/**
27			* @var array options used to build [[form]]
28			* @see buildForm()
29			*/
30			public $formOptions = [];
31
32			/**
33			* @var string
34			*/
35			public $scenario;
36
37			/**
38			* @var Tariff The actual tariff
39			*/
40			protected $tariff;
41
42			/**
43			* @var string The type used to find base tariff
44			*/
45			protected $type;
46
47			public function init()
48			{
49			$this->findBaseTariffs();
50			$this->buildForm();
51			}
52
53			/**
54			* Fills [[form]] property with a proper [[AbstractTariffForm]] object
55			*/
56			protected function buildForm()
57			{
58			$this->form = Yii::createObject(array_merge([
59			'scenario' => $this->scenario,
60			'baseTariffs' => $this->baseTariffs,
61			'tariff' => $this->tariff
62			], $this->getFormOptions()));
63			}
64
65			protected function getFormOptions()
66			{
67			return $this->formOptions;
68			}
69
70			protected function findBaseTariffs()
71			{
72			$availableTariffs = Tariff::find(['scenario' => 'get-available-info'])
73			->andFilterWhere(['type' => $this->type])
74			->all();
75
76			if (empty($availableTariffs)) {
77			throw new ForbiddenHttpException('No available tariffs found');
78			}
79
80			$this->baseTariffs = Tariff::find()
81			->where(['id' => ArrayHelper::getColumn($availableTariffs, 'id')])
82			->details()
83			->all();
84			}
85
86			public function getType()
87			{
88			return $this->type;
89			}
90
91			/**
92			* @var TariffCalculator
93			*/
94			protected $_calculator;
95
96			/**
97			* @return TariffCalculator
98			*/
99			protected function calculator()
100			{
101			if (isset($this->_calculator)) {
102			return $this->_calculator;
103			}
104
105			$this->_calculator = new TariffCalculator($this->tariff);
106
107			return $this->_calculator;
108			}
109
110			public function calculation()
111			{
112			return $this->calculator()->getCalculation($this->tariff->id)->forCurrency($this->tariff->currency);
			0 ignored issues – show Documentation introduced 2016-09-13 16:41 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\finance\models\Tariff>`. 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... Documentation introduced 2016-09-13 16:41 UTC by Report Bug Copy Issue Report The property `currency` does not exist on `object<hipanel\modules\finance\models\Tariff>`. 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...
113			}
114
115			/**
116			* @param Tariff $tariff
117			*/
118			public function setTariff($tariff)
119			{
120			$this->tariff = $tariff;
121			}
122			}
123

hiqdev / hipanel-module-finance

Push — master ( 5a5e4b...77b1bb )

AbstractTariffManager A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

Duplication Side-by-Side

Filter issues like