AbstractTariffForm - Code Metrics - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

AbstractTariffForm A
last analyzed 2020-11-24 16:48 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	30
lcom	1
cbo	6
dl	0
loc	267
ccs	0
cts	131
cp	0
rs	10
c	0
b	0
f	0

22 Methods

Rating	Name	Size	Complexity
A	init()	4	1
A	initTariff()	6	2
A	ensureTariff()	8	2
A	ensureScenario()	6	2
A	setDefaultTariff()	12	2
A	rules()	9	1
A	fields()	6	1
A	attributes()	8	1
A	getResources()	4	1
A	setResources()	4	1
A	getResourceTypes()	6	2
A	attributeLabels()	9	1
A	load()	4	1
A	insert()	4	1
A	update()	4	1
A	getTariff()	4	1
A	setTariff()	13	2
A	getPrimaryKey()	4	1
A	calculator()	8	2
A	calculation()	4	1
A	parentCalculator()	8	2
A	parentCalculation()	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\forms;

use hipanel\modules\finance\logic\Calculator;
use hipanel\modules\finance\models\Tariff;
use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;

abstract class AbstractTariffForm extends \yii\base\Model
{
    /**
     * @var int Tariff ID
     */
    public $id;

    /**
     * @var string Tariff name
     */
    public $name;

    /**
     * @var int Parent tariff ID
     */
    public $parent_id;

    /**
     * @var Tariff the selected parent tariff
     */
    public $parentTariff;

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

    /**
     * @var \hipanel\modules\finance\models\Resource[]
     */
    protected $_resources;

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        $this->initTariff();
    }

    /**
     * Initializes tariff.
     * @void
     */
    protected function initTariff()
    {
        if ($this->ensureTariff()) {
            $this->ensureScenario();
        }
    }

    /**
     * Ensures that [[tariff]] is set.
     * Otherwise calls [[setDefaultTariff()]].
     * @return bool
     */
    protected function ensureTariff()
    {
        if ($this->getTariff() instanceof Tariff) {
            return true;
        }

        return $this->setDefaultTariff();
    }

    protected function ensureScenario()
    {
        foreach ($this->tariff->resources as $resource) {
            $resource->scenario = $this->scenario;
        }
    }

    /**
     * Sets default tariff.
     *
     * @return bool success
     */
    protected function setDefaultTariff()
    {
        if (!$this->setTariff($this->parentTariff)) {
            return false;
        }

        // Default tariff's id and name are useless on create
        $this->id = null;
        $this->name = null;

        return true;
    }

    /** {@inheritdoc} */
    public function rules()
    {
        return [
            [['name'], 'required', 'on' => ['create', 'update']],
            [['parent_id', 'id'], 'integer', 'on' => ['create', 'update']],
            'parent-id-required' => [['parent_id'], 'required', 'on' => ['create']],
            [['id'], 'required', 'on' => ['update']],
        ];
    }

    /** {@inheritdoc} */
    public function fields()
    {
        return ArrayHelper::merge(array_combine($this->attributes(), $this->attributes()), [
            'resources' => '_resources',
        ]);
    }

    /** {@inheritdoc} */
    public function attributes()
    {
        return [
            'id',
            'parent_id',
            'name',
        ];
    }

    /**
     * @return \hipanel\modules\finance\models\Resource[]
     */
    public function getResources()
    {
        return $this->_resources;
    }

    /**
     * @param \hipanel\modules\finance\models\Resource[] $resources
     * @throws InvalidConfigException when not implemented
     */
    public function setResources($resources)
    {
        throw new InvalidConfigException('Method "setResources" must be implemented');
    }

    /**
     * @return array
     */
    public function getResourceTypes(): array
    {
        $res = $this->parentTariff->resources;

        return $res ? reset($res)->getTypes() : [];
    }

    /**
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'parent_id' => Yii::t('hipanel:finance:tariff', 'Parent tariff'),
            'name' => Yii::t('hipanel:finance:tariff', 'Name'),
            'label' => Yii::t('hipanel:finance:tariff', 'Label'),
            'note' => Yii::t('hipanel', 'Note'),
        ];
    }

    /**
     * @param array $data to be loaded
     * @param null $formName
     * @throws InvalidConfigException when not implemented
     * @return bool
     */
    public function load($data, $formName = null)
    {
        throw new InvalidConfigException('Method load must be implemented');
    }

    public function insert($runValidation = true)

    {
        throw new InvalidConfigException('Method insert must be implemented');
    }

    public function update($runValidation = true)

    {
        throw new InvalidConfigException('Method update must be implemented');
    }

    /**
     * @return Tariff
     */
    public function getTariff()
    {
        return $this->tariff;
    }

    /**
     * Sets [[tariff]].
     *
     * @param Tariff $tariff
     * @return bool
     */
    public function setTariff($tariff)
    {
        if ($tariff === null) {
            return false;
        }

        $this->tariff = $tariff;

        $this->id = $tariff->id;
<?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->name = $tariff->name;
<?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;
    }

    public function getPrimaryKey()
    {
        return ['id'];
    }

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

    /**
     * Creates [[TariffCalculator]] object for the [[tariff]].
     *
     * @return Calculator
     */
    protected function calculator()
    {
        if (!isset($this->_calculator)) {
            $this->_calculator = new Calculator([$this->tariff]);
        }

        return $this->_calculator;
    }

    /**
     * @return \hipanel\modules\finance\models\Value
     */
    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.");
        }
    }

}
    }

    /**
     * @var Calculator
     */
    protected $_parentCalculator;

    /**
     * Creates [[TariffCalculator]] object for the [[parentTariff]].
     *
     * @return Calculator
     */
    protected function parentCalculator()
    {
        if (!isset($this->_parentCalculator)) {
            $this->_parentCalculator = new Calculator([$this->parentTariff]);
        }

        return $this->_parentCalculator;
    }

    /**
     * @return \hipanel\modules\finance\models\Value
     */
    public function parentCalculation()
    {
        return $this->parentCalculator()->getCalculation($this->parentTariff->id)->forCurrency($this->parentTariff->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.");
        }
    }

}
    }
}


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\forms;
12
13			use hipanel\modules\finance\logic\Calculator;
14			use hipanel\modules\finance\models\Tariff;
15			use Yii;
16			use yii\base\InvalidConfigException;
17			use yii\helpers\ArrayHelper;
18
19			abstract class AbstractTariffForm extends \yii\base\Model
20			{
21			/**
22			* @var int Tariff ID
23			*/
24			public $id;
25
26			/**
27			* @var string Tariff name
28			*/
29			public $name;
30
31			/**
32			* @var int Parent tariff ID
33			*/
34			public $parent_id;
35
36			/**
37			* @var Tariff the selected parent tariff
38			*/
39			public $parentTariff;
40
41			/**
42			* @var Tariff
43			*/
44			protected $tariff;
45
46			/**
47			* @var \hipanel\modules\finance\models\Resource[]
48			*/
49			protected $_resources;
50
51			/**
52			* {@inheritdoc}
53			*/
54			public function init()
55			{
56			$this->initTariff();
57			}
58
59			/**
60			* Initializes tariff.
61			* @void
62			*/
63			protected function initTariff()
64			{
65			if ($this->ensureTariff()) {
66			$this->ensureScenario();
67			}
68			}
69
70			/**
71			* Ensures that [[tariff]] is set.
72			* Otherwise calls [[setDefaultTariff()]].
73			* @return bool
74			*/
75			protected function ensureTariff()
76			{
77			if ($this->getTariff() instanceof Tariff) {
78			return true;
79			}
80
81			return $this->setDefaultTariff();
82			}
83
84			protected function ensureScenario()
85			{
86			foreach ($this->tariff->resources as $resource) {
87			$resource->scenario = $this->scenario;
88			}
89			}
90
91			/**
92			* Sets default tariff.
93			*
94			* @return bool success
95			*/
96			protected function setDefaultTariff()
97			{
98			if (!$this->setTariff($this->parentTariff)) {
99			return false;
100			}
101
102			// Default tariff's id and name are useless on create
103			$this->id = null;
104			$this->name = null;
105
106			return true;
107			}
108
109			/** {@inheritdoc} */
110			public function rules()
111			{
112			return [
113			[['name'], 'required', 'on' => ['create', 'update']],
114			[['parent_id', 'id'], 'integer', 'on' => ['create', 'update']],
115			'parent-id-required' => [['parent_id'], 'required', 'on' => ['create']],
116			[['id'], 'required', 'on' => ['update']],
117			];
118			}
119
120			/** {@inheritdoc} */
121			public function fields()
122			{
123			return ArrayHelper::merge(array_combine($this->attributes(), $this->attributes()), [
124			'resources' => '_resources',
125			]);
126			}
127
128			/** {@inheritdoc} */
129			public function attributes()
130			{
131			return [
132			'id',
133			'parent_id',
134			'name',
135			];
136			}
137
138			/**
139			* @return \hipanel\modules\finance\models\Resource[]
140			*/
141			public function getResources()
142			{
143			return $this->_resources;
144			}
145
146			/**
147			* @param \hipanel\modules\finance\models\Resource[] $resources
148			* @throws InvalidConfigException when not implemented
149			*/
150			public function setResources($resources)
151			{
152			throw new InvalidConfigException('Method "setResources" must be implemented');
153			}
154
155			/**
156			* @return array
157			*/
158			public function getResourceTypes(): array
159			{
160			$res = $this->parentTariff->resources;
161
162			return $res ? reset($res)->getTypes() : [];
163			}
164
165			/**
166			* @return array
167			*/
168			public function attributeLabels()
169			{
170			return [
171			'parent_id' => Yii::t('hipanel:finance:tariff', 'Parent tariff'),
172			'name' => Yii::t('hipanel:finance:tariff', 'Name'),
173			'label' => Yii::t('hipanel:finance:tariff', 'Label'),
174			'note' => Yii::t('hipanel', 'Note'),
175			];
176			}
177
178			/**
179			* @param array $data to be loaded
180			* @param null $formName
181			* @throws InvalidConfigException when not implemented
182			* @return bool
183			*/
184			public function load($data, $formName = null)
185			{
186			throw new InvalidConfigException('Method load must be implemented');
187			}
188
189			public function insert($runValidation = true)
			0 ignored issues – show Unused Code introduced 2017-07-31 11:20 UTC by Report Bug Copy Issue Report The parameter `$runValidation` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
190			{
191			throw new InvalidConfigException('Method insert must be implemented');
192			}
193
194			public function update($runValidation = true)
			0 ignored issues – show Unused Code introduced 2017-07-31 11:20 UTC by Report Bug Copy Issue Report The parameter `$runValidation` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
195			{
196			throw new InvalidConfigException('Method update must be implemented');
197			}
198
199			/**
200			* @return Tariff
201			*/
202			public function getTariff()
203			{
204			return $this->tariff;
205			}
206
207			/**
208			* Sets [[tariff]].
209			*
210			* @param Tariff $tariff
211			* @return bool
212			*/
213			public function setTariff($tariff)
214			{
215			if ($tariff === null) {
216			return false;
217			}
218
219			$this->tariff = $tariff;
220
221			$this->id = $tariff->id;
			0 ignored issues – show Documentation introduced 2016-09-08 16:30 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\finance\models\Tariff>`. 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...
222			$this->name = $tariff->name;
			0 ignored issues – show Documentation introduced 2016-09-08 16:30 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<hipanel\modules\finance\models\Tariff>`. 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...
223
224			return true;
225			}
226
227			public function getPrimaryKey()
228			{
229			return ['id'];
230			}
231
232			/**
233			* @var Calculator
234			*/
235			protected $_calculator;
236
237			/**
238			* Creates [[TariffCalculator]] object for the [[tariff]].
239			*
240			* @return Calculator
241			*/
242			protected function calculator()
243			{
244			if (!isset($this->_calculator)) {
245			$this->_calculator = new Calculator([$this->tariff]);
246			}
247
248			return $this->_calculator;
249			}
250
251			/**
252			* @return \hipanel\modules\finance\models\Value
253			*/
254			public function calculation()
255			{
256			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...
257			}
258
259			/**
260			* @var Calculator
261			*/
262			protected $_parentCalculator;
263
264			/**
265			* Creates [[TariffCalculator]] object for the [[parentTariff]].
266			*
267			* @return Calculator
268			*/
269			protected function parentCalculator()
270			{
271			if (!isset($this->_parentCalculator)) {
272			$this->_parentCalculator = new Calculator([$this->parentTariff]);
273			}
274
275			return $this->_parentCalculator;
276			}
277
278			/**
279			* @return \hipanel\modules\finance\models\Value
280			*/
281			public function parentCalculation()
282			{
283			return $this->parentCalculator()->getCalculation($this->parentTariff->id)->forCurrency($this->parentTariff->currency);
			0 ignored issues – show Documentation introduced 2016-09-16 15:33 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-16 15:33 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...
284			}
285			}
286

hiqdev / hipanel-module-finance

AbstractTariffForm A last analyzed 2020-11-24 16:48 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

22 Methods

Duplication Side-by-Side

Filter issues like

AbstractTariffForm A
last analyzed 2020-11-24 16:48 UTC