RelatedPosition - Code Metrics - Inspection of "Moved Relate positions from yii2-cart (#145)" - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e1e196...2d2d66 )

by Dmitry

created 2020-03-19 17:15 UTC

RelatedPosition A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	5
dl	0
loc	34
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	render()	4	1
A	calculate()	12	1

<?php

namespace hipanel\modules\finance\cart;

use hipanel\modules\finance\logic\Calculator;
use hipanel\modules\finance\models\CalculableModelInterface;
use hiqdev\yii2\cart\CartPositionInterface;
use hiqdev\yii2\cart\Module;
use hiqdev\yii2\cart\ShoppingCart;

abstract class RelatedPosition implements RelatedPositionInterface
{
    /** @var CartPositionInterface */
    public $mainPosition;

    /** @var ShoppingCart */
    public $cart;

    public function __construct(CartPositionInterface $mainPosition)
    {
        $this->cart = Module::getInstance()->getCart();
        $this->mainPosition = $mainPosition;
    }

    /** @inheritDoc */
    public function render(): string
    {
        return $this->getWidget()->run();
    }

    public function calculate(CalculableModelInterface $position): CalculableModelInterface
    {
        $calculator = new Calculator([$position]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $calculationId = $position->getCalculationModel()->calculation_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.");
        }
    }

}
        $calculation = $calculator->getCalculation($calculationId);
        $value = $calculation->forCurrency($this->cart->getCurrency());
        $position->setPrice($value->price);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $position->setValue($value->value);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $position->setCurrency($value->currency);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $position;
    }

}


Push — master ( e1e196...2d2d66 )

RelatedPosition A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace hipanel\modules\finance\cart;
4
5			use hipanel\modules\finance\logic\Calculator;
6			use hipanel\modules\finance\models\CalculableModelInterface;
7			use hiqdev\yii2\cart\CartPositionInterface;
8			use hiqdev\yii2\cart\Module;
9			use hiqdev\yii2\cart\ShoppingCart;
10
11			abstract class RelatedPosition implements RelatedPositionInterface
12			{
13			/** @var CartPositionInterface */
14			public $mainPosition;
15
16			/** @var ShoppingCart */
17			public $cart;
18
19			public function __construct(CartPositionInterface $mainPosition)
20			{
21			$this->cart = Module::getInstance()->getCart();
22			$this->mainPosition = $mainPosition;
23			}
24
25			/** @inheritDoc */
26			public function render(): string
27			{
28			return $this->getWidget()->run();
29			}
30
31			public function calculate(CalculableModelInterface $position): CalculableModelInterface
32			{
33			$calculator = new Calculator([$position]);
			0 ignored issues – show Documentation introduced 2020-03-19 15:34 UTC by Report Bug Copy Issue Report `array($position)` is of type `array<integer,object<hip...lableModelInterface>"}>`, but the function expects a `array<integer,object<yii\base\Model>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
34			$calculationId = $position->getCalculationModel()->calculation_id;
			0 ignored issues – show Documentation introduced 2020-03-19 15:34 UTC by Report Bug Copy Issue Report The property `calculation_id` does not exist on `object<hipanel\modules\f...nce\models\Calculation>`. 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...
35			$calculation = $calculator->getCalculation($calculationId);
36			$value = $calculation->forCurrency($this->cart->getCurrency());
37			$position->setPrice($value->price);
			0 ignored issues – show Bug introduced 2020-03-19 15:34 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hipanel\modules\finance\...alculableModelInterface` as the method `setPrice()` does only exist in the following implementations of said interface: `hipanel\modules\finance\cart\AbstractCartPosition`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
38			$position->setValue($value->value);
			0 ignored issues – show Bug introduced 2020-03-19 15:34 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hipanel\modules\finance\...alculableModelInterface` as the method `setValue()` does only exist in the following implementations of said interface: `hipanel\modules\finance\cart\AbstractCartPosition`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
39			$position->setCurrency($value->currency);
			0 ignored issues – show Bug introduced 2020-03-19 15:34 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hipanel\modules\finance\...alculableModelInterface` as the method `setCurrency()` does only exist in the following implementations of said interface: `hipanel\modules\finance\cart\AbstractCartPosition`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
40
41			return $position;
42			}
43
44			}
45

hiqdev / hipanel-module-finance

Push — master ( e1e196...2d2d66 )

RelatedPosition A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like