AbstractPrice::calculateSum() - Code Metrics - Inspection of "first test (SinglePrice) passed URA" - hiqdev/php-billing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cbae82...6b14db )

by Andrii

created 2017-04-01 18:15 UTC

AbstractPrice::calculateSum() A

↳ Parent: AbstractPrice

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
nc	3
cc	3
eloc	8
nop	1

<?php
/**
 * PHP Billing Library
 *
 * @link      https://github.com/hiqdev/php-billing
 * @package   php-billing
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\php\billing;

use hiqdev\php\units\QuantityInterface;

/**
 * Price.
 * @see PriceInterface
 *
 * @author Andrii Vasyliev <[email protected]>
 */
abstract class AbstractPrice implements PriceInterface
{
    /**
     * @var integer
     */
    protected $id;

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

    /**
     * @var Target
     */
    protected $target;

    /**
     * @var Type
     */
    protected $type;

    public function __construct(TargetInterface $target, TypeInterface $type)
    {
        $this->target = $target;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->type = $type;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * @inheritdoc
     */
    public function getTarget()
    {
        return $this->target;
    }

    /**
     * @inheritdoc
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @inheritdoc
     */
    public function calculateCharge(ActionInterface $action)
    {
        if (!$action->isApplicable($this)) {
            return null;
        }

        $usage = $this->calculateUsage($action->getQuantity());
        if ($usage === null) {
            return null;
        }

        $sum = $this->calculateSum($action->getQuantity());
        if ($sum === null) {
            return null;
        }

        return new Charge($action, $this->target, $this->type, $usage, $sum);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     * Default sum calculation method: sum = price * usage
     */
    public function calculateSum(QuantityInterface $quantity)
    {
        $usage = $this->calculateUsage($quantity);
        if ($usage === null) {
            return null;
        }

        $price = $this->calculatePrice($quantity);
        if ($price === null) {
            return null;
        }

        return $price->multiply($usage->getQuantity());
    }

    /**
     * @inheritdoc
     */
    abstract public function calculateUsage(QuantityInterface $quantity);

    /**
     * @inheritdoc
     */
    abstract public function calculatePrice(QuantityInterface $action);
}


1			<?php
2			/**
3			* PHP Billing Library
4			*
5			* @link https://github.com/hiqdev/php-billing
6			* @package php-billing
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hiqdev\php\billing;
12
13			use hiqdev\php\units\QuantityInterface;
14
15			/**
16			* Price.
17			* @see PriceInterface
18			*
19			* @author Andrii Vasyliev <[email protected]>
20			*/
21			abstract class AbstractPrice implements PriceInterface
22			{
23			/**
24			* @var integer
25			*/
26			protected $id;
27
28			/**
29			* @var Tariff
30			*/
31			protected $tariff;
32
33			/**
34			* @var Target
35			*/
36			protected $target;
37
38			/**
39			* @var Type
40			*/
41			protected $type;
42
43			public function __construct(TargetInterface $target, TypeInterface $type)
44			{
45			$this->target = $target;
			0 ignored issues – show Documentation Bug introduced 2017-04-01 18:18 UTC by Report Bug Copy Issue Report `$target` is of type `object<hiqdev\php\billing\TargetInterface>`, but the property `$target` was declared to be of type `object<hiqdev\php\billing\Target>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` 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 given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
46			$this->type = $type;
			0 ignored issues – show Documentation Bug introduced 2017-04-01 18:18 UTC by Report Bug Copy Issue Report `$type` is of type `object<hiqdev\php\billing\TypeInterface>`, but the property `$type` was declared to be of type `object<hiqdev\php\billing\Type>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` 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 given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
47			}
48
49			/**
50			* @inheritdoc
51			*/
52			public function getTarget()
53			{
54			return $this->target;
55			}
56
57			/**
58			* @inheritdoc
59			*/
60			public function getType()
61			{
62			return $this->type;
63			}
64
65			/**
66			* @inheritdoc
67			*/
68			public function calculateCharge(ActionInterface $action)
69			{
70			if (!$action->isApplicable($this)) {
71			return null;
72			}
73
74			$usage = $this->calculateUsage($action->getQuantity());
75			if ($usage === null) {
76			return null;
77			}
78
79			$sum = $this->calculateSum($action->getQuantity());
80			if ($sum === null) {
81			return null;
82			}
83
84			return new Charge($action, $this->target, $this->type, $usage, $sum);
			0 ignored issues – show Bug Best Practice introduced 2017-03-29 15:24 UTC by Report Bug Copy Issue Report The return type of `return new \hiqdev\php\b...s->type, $usage, $sum);` (`hiqdev\php\billing\Charge`) is incompatible with the return type declared by the interface `hiqdev\php\billing\PriceInterface::calculateCharge` of type `hiqdev\php\billing\ChargeInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history... Documentation introduced 2017-04-01 18:18 UTC by Report Bug Copy Issue Report `$usage` is of type `object<hiqdev\php\units\QuantityInterface>`, but the function expects a `object<hiqdev\php\billing\QuantityInterface>`. 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... Documentation introduced 2017-04-01 18:18 UTC by Report Bug Copy Issue Report `$sum` is of type `object<Money\Money>`, but the function expects a `object<hiqdev\php\billing\MoneyInterface>`. 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...
85			}
86
87			/**
88			* @inheritdoc
89			* Default sum calculation method: sum = price * usage
90			*/
91			public function calculateSum(QuantityInterface $quantity)
92			{
93			$usage = $this->calculateUsage($quantity);
94			if ($usage === null) {
95			return null;
96			}
97
98			$price = $this->calculatePrice($quantity);
99			if ($price === null) {
100			return null;
101			}
102
103			return $price->multiply($usage->getQuantity());
104			}
105
106			/**
107			* @inheritdoc
108			*/
109			abstract public function calculateUsage(QuantityInterface $quantity);
110
111			/**
112			* @inheritdoc
113			*/
114			abstract public function calculatePrice(QuantityInterface $action);
115			}
116

hiqdev / php-billing

Push — master ( cbae82...6b14db )

AbstractPrice::calculateSum() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like