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

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

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	149
Duplicated Lines	17.45 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	18
lcom	1
cbo	7
dl	26
loc	149
ccs	0
cts	78
cp	0
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	9	2
A	buildForm()	0	9	1
A	getFormOptions()	0	4	1
A	initParentTariff()	0	19	4
A	determineParentTariff()	0	16	4
A	getType()	0	4	1
A	setTariff()	0	4	1
A	insert()	14	14	2
A	update()	12	12	2

How to fix Duplicated Code

<?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\logic;

use hipanel\modules\finance\forms\AbstractTariffForm;
use hipanel\modules\finance\models\Tariff;
use hiqdev\hiart\ResponseErrorException;
use Yii;
use yii\base\BaseObject;
use yii\base\InvalidConfigException;
use yii\web\UnprocessableEntityHttpException;

abstract class AbstractTariffManager extends BaseObject
{
    /**
     * @var int Parent tariff ID
     */
    public $parent_id;

    /**
     * @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 Tariff Parent tariff
     */
    protected $parentTariff;

    /**
     * @var string The type used to find parent tariffs
     */
    protected $type;

    public function init()
    {
        if (!isset($this->type)) {
            throw new InvalidConfigException('Property "type" must be set');
        }

        $this->initParentTariff();
        $this->buildForm();
    }

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

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

    protected function initParentTariff()
    {
        $id = $this->determineParentTariff();

        if ($id === null) {
            return;
        }

        $this->parent_id = $id;
        $this->parentTariff = Tariff::find()
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            ->where(['id' => $id])
            ->details()
            ->one();

        // In case parent tariff is not available - use current tariff as the last hope fallback
        if ($this->parentTariff === null && $this->tariff !== null) {
            $this->parentTariff = clone $this->tariff;
        }
    }

    /**
     * Finds parent tariff ID.
     *
     * @return int
     */
    protected function determineParentTariff()
    {
        if ($this->tariff === null) {
            if (!empty($this->parent_id)) {
                return $this->parent_id;
            }

            return null;
        }

        if ($this->tariff->parent_id !== null) {
<?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 $this->tariff->parent_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.");
        }
    }

}
        }

        return $this->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.");
        }
    }

}
    }

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

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

    public function insert(): bool

    {
        $data = $this->form->toArray();

        try {
            $result = Tariff::perform('create', $data);
        } catch (ResponseErrorException $e) {
            throw new UnprocessableEntityHttpException($e->getMessage(), 0, $e);
        }

        $this->form->id = $result['id'];

        return true;
    }

    public function update(): bool

    {
        $data = $this->form->toArray();

        try {
            $result = Tariff::perform('update', $data);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        } catch (ResponseErrorException $e) {
            throw new UnprocessableEntityHttpException($e->getMessage(), 0, $e);
        }

        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\logic;
12
13		use hipanel\modules\finance\forms\AbstractTariffForm;
14		use hipanel\modules\finance\models\Tariff;
15		use hiqdev\hiart\ResponseErrorException;
16		use Yii;
17		use yii\base\BaseObject;
18		use yii\base\InvalidConfigException;
19		use yii\web\UnprocessableEntityHttpException;
20
21		abstract class AbstractTariffManager extends BaseObject
22		{
23		/**
24		* @var int Parent tariff ID
25		*/
26		public $parent_id;
27
28		/**
29		* @var AbstractTariffForm
30		*/
31		public $form;
32
33		/**
34		* @var array options used to build [[form]]
35		* @see buildForm()
36		*/
37		public $formOptions = [];
38
39		/**
40		* @var string
41		*/
42		public $scenario;
43
44		/**
45		* @var Tariff The actual tariff
46		*/
47		protected $tariff;
48
49		/**
50		* @var Tariff Parent tariff
51		*/
52		protected $parentTariff;
53
54		/**
55		* @var string The type used to find parent tariffs
56		*/
57		protected $type;
58
59		public function init()
60		{
61		if (!isset($this->type)) {
62		throw new InvalidConfigException('Property "type" must be set');
63		}
64
65		$this->initParentTariff();
66		$this->buildForm();
67		}
68
69		/**
70		* Fills [[form]] property with a proper [[AbstractTariffForm]] object.
71		*/
72		protected function buildForm()
73		{
74		$this->form = Yii::createObject(array_merge([
75		'scenario' => $this->scenario,
76		'parent_id' => $this->parent_id,
77		'parentTariff' => $this->parentTariff,
78		'tariff' => $this->tariff,
79		], $this->getFormOptions()));
80		}
81
82		protected function getFormOptions()
83		{
84		return $this->formOptions;
85		}
86
87		protected function initParentTariff()
88		{
89		$id = $this->determineParentTariff();
90
91		if ($id === null) {
92		return;
93		}
94
95		$this->parent_id = $id;
96		$this->parentTariff = Tariff::find()
		0 ignored issues – show Documentation Bug introduced 2017-07-20 10:34 UTC by Report Bug Copy Issue Report It seems like `\hipanel\modules\finance...$id))->details()->one()` can also be of type `object<hiqdev\hiart\ActiveRecord>` or `array`. However, the property `$parentTariff` is declared as type `object<hipanel\modules\finance\models\Tariff>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
97		->where(['id' => $id])
98		->details()
99		->one();
100
101		// In case parent tariff is not available - use current tariff as the last hope fallback
102		if ($this->parentTariff === null && $this->tariff !== null) {
103		$this->parentTariff = clone $this->tariff;
104		}
105		}
106
107		/**
108		* Finds parent tariff ID.
109		*
110		* @return int
111		*/
112		protected function determineParentTariff()
113		{
114		if ($this->tariff === null) {
115		if (!empty($this->parent_id)) {
116		return $this->parent_id;
117		}
118
119		return null;
120		}
121
122		if ($this->tariff->parent_id !== null) {
		0 ignored issues – show Documentation introduced 2017-08-16 16:12 UTC by Report Bug Copy Issue Report The property `parent_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...
123		return $this->tariff->parent_id;
		0 ignored issues – show Documentation introduced 2016-09-22 13:20 UTC by Report Bug Copy Issue Report The property `parent_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...
124		}
125
126		return $this->tariff->id;
		0 ignored issues – show Documentation introduced 2017-06-22 09:47 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...
127		}
128
129		public function getType()
130		{
131		return $this->type;
132		}
133
134		/**
135		* @param Tariff $tariff
136		*/
137		public function setTariff($tariff)
138		{
139		$this->tariff = $tariff;
140		}
141
142	View Code Duplication	public function insert(): bool
		0 ignored issues – show Duplication introduced 2019-03-05 09:59 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...
143		{
144		$data = $this->form->toArray();
145
146		try {
147		$result = Tariff::perform('create', $data);
148		} catch (ResponseErrorException $e) {
149		throw new UnprocessableEntityHttpException($e->getMessage(), 0, $e);
150		}
151
152		$this->form->id = $result['id'];
153
154		return true;
155		}
156
157	View Code Duplication	public function update(): bool
		0 ignored issues – show Duplication introduced 2017-07-31 11:20 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...
158		{
159		$data = $this->form->toArray();
160
161		try {
162		$result = Tariff::perform('update', $data);
		0 ignored issues – show Unused Code introduced 2017-06-23 13:06 UTC by Report Bug Copy Issue Report `$result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
163		} catch (ResponseErrorException $e) {
164		throw new UnprocessableEntityHttpException($e->getMessage(), 0, $e);
165		}
166
167		return true;
168		}
169		}
170

hiqdev / hipanel-module-finance

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

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

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