TemplatePrice::getSubprice() - Code Metrics - Inspection of "Implemented prices suggestion for DS, vCDN, pCDN" - hiqdev/billing-hiapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd4ae6...0b395f )

by Dmitry

created 2018-05-23 15:12 UTC

TemplatePrice::getSubprice() A

↳ Parent: TemplatePrice

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	2

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

namespace hiqdev\billing\hiapi\price;

use hiqdev\php\billing\plan\PlanInterface;
use hiqdev\php\billing\price\SinglePrice;
use hiqdev\php\billing\target\TargetInterface;
use hiqdev\php\billing\type\TypeInterface;
use hiqdev\php\units\QuantityInterface;
use Money\Money;

/**
 * Class TemplatePrice.
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class TemplatePrice extends SinglePrice
{
    /**
     * @var Money[]
     */
    protected $subprices = [];

    public function __construct(
        $id,
        TypeInterface $type,
        TargetInterface $target,
        PlanInterface $plan = null,
        QuantityInterface $prepaid,
        Money $price,
        array $subprices
    ) {
        parent::__construct($id, $type, $target, $plan, $prepaid, $price);

        $this->subprices = $subprices;
    }

    public function jsonSerialize()
    {
        return array_merge(parent::jsonSerialize(), [
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'subprices' => $this->subprices,
        ]);
    }

    /**
     * @return Money[]
     */
    public function getSubprices(): array
    {
        return $this->subprices;
    }

    /**
     * @param string $currencyCode
     * @return string the subprice in decimal format (e.g. `10.25`)
     */
    public function getSubprice($currencyCode): string
    {
        return $this->subprices[strtoupper($currencyCode)] ?? '0';
    }
}


1			<?php
2			/**
3			* API for Billing
4			*
5			* @link https://github.com/hiqdev/billing-hiapi
6			* @package billing-hiapi
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2017-2018, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hiqdev\billing\hiapi\price;
12
13			use hiqdev\php\billing\plan\PlanInterface;
14			use hiqdev\php\billing\price\SinglePrice;
15			use hiqdev\php\billing\target\TargetInterface;
16			use hiqdev\php\billing\type\TypeInterface;
17			use hiqdev\php\units\QuantityInterface;
18			use Money\Money;
19
20			/**
21			* Class TemplatePrice.
22			*
23			* @author Dmytro Naumenko <[email protected]>
24			*/
25			class TemplatePrice extends SinglePrice
26			{
27			/**
28			* @var Money[]
29			*/
30			protected $subprices = [];
31
32			public function __construct(
33			$id,
34			TypeInterface $type,
35			TargetInterface $target,
36			PlanInterface $plan = null,
37			QuantityInterface $prepaid,
38			Money $price,
39			array $subprices
40			) {
41			parent::__construct($id, $type, $target, $plan, $prepaid, $price);
42
43			$this->subprices = $subprices;
44			}
45
46			public function jsonSerialize()
47			{
48			return array_merge(parent::jsonSerialize(), [
			0 ignored issues – show Best Practice introduced 2018-02-12 09:20 UTC by Report Bug Copy Issue Report The expression `return array_merge(paren... => $this->subprices));` seems to be an `array`, but some of its elements' types (`Money\Money[]`) are incompatible with the return type of the parent method `hiqdev\php\billing\price...glePrice::jsonSerialize` of type `array<string,integer\|hiq...s\Quantity\|Money\Money>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
49			'subprices' => $this->subprices,
50			]);
51			}
52
53			/**
54			* @return Money[]
55			*/
56			public function getSubprices(): array
57			{
58			return $this->subprices;
59			}
60
61			/**
62			* @param string $currencyCode
63			* @return string the subprice in decimal format (e.g. `10.25`)
64			*/
65			public function getSubprice($currencyCode): string
66			{
67			return $this->subprices[strtoupper($currencyCode)] ?? '0';
68			}
69			}
70

hiqdev / billing-hiapi

Push — master ( bd4ae6...0b395f )

TemplatePrice::getSubprice() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like