hiqdev\php\billing\price\SinglePrice

Complexity

Total Complexity

7

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

77.78%

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getPrepaid()	0	4	1
A	getPrice()	0	4	1
A	calculateUsage()	0	6	2
A	calculatePrice()	0	4	1
A	__construct()	0	12	1
A	jsonSerialize()	0	7	1

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

namespace hiqdev\php\billing\price;

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

/**
 * Single Price.
 *
 * - no charge for quantity less then prepaid
 * - same price for any quantity above prepaid
 *
 * @see PriceInterface
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class SinglePrice extends AbstractPrice
{
    /**
     * @var Quantity prepaid quantity also implies Unit
     */
    protected $prepaid;

    /**
     * @var Money
     */
    protected $price;

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

$prepaid is of type object<hiqdev\php\units\QuantityInterface>, but the property $prepaid was declared to be of type object<hiqdev\php\units\Quantity>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        $this->price    = $price;
    }

    public function getPrepaid()
    {
        return $this->prepaid;
    }

    public function getPrice()
    {
        return $this->price;
    }

    /**
     * {@inheritdoc}
     */
    public function calculateUsage(QuantityInterface $quantity): ?QuantityInterface
    {
        $usage = $quantity->convert($this->prepaid->getUnit())->subtract($this->prepaid);

        return $usage->isPositive() ? $usage : null;
    }

    /**
     * {@inheritdoc}
     * Same price for any usage.
     */
    public function calculatePrice(QuantityInterface $usage): ?Money
    {
        return $this->price;
    }

    public function jsonSerialize()
    {
        return array_merge(parent::jsonSerialize(), [
            'prepaid' => $this->prepaid,
            'price' => $this->price,
        ]);
    }
}