hiqdev\php\billing\plan\Plan

Complexity

Total Complexity

12

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

50%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	getUniqueId()	0	4	1
A	getId()	0	4	1
A	hasPrices()	0	4	1
A	getPrices()	0	4	1
A	setPrices()	0	7	2
A	calculateCharges()	0	12	3
A	jsonSerialize()	0	4	1
A	getSeller()	0	4	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\plan;

use hiqdev\php\billing\action\ActionInterface;
use hiqdev\php\billing\charge\Charge;
use hiqdev\php\billing\charge\ChargeInterface;
use hiqdev\php\billing\charge\ChargeModifier;
use hiqdev\php\billing\customer\CustomerInterface;
use hiqdev\php\billing\price\PriceInterface;

/**
 * Tariff Plan.
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class Plan implements PlanInterface
{
    /**
     * @var int
     */
    protected $id;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var Plan|null
     * XXX not sure to implement
     */
    protected $parent;

    /**
     * @var CustomerInterface
     */
    protected $seller;

    /**
     * @var PriceInterface[]
     */
    protected $prices;

    /**
     * @param int $id
     * @param string $name
     * @param CustomerInterface|null $seller
     * @param PriceInterface[] $prices
     */
    public function __construct(
                            $id,
                            $name,
        CustomerInterface   $seller = null,
                            $prices = null
    ) {
        $this->id = $id;
        $this->name = $name;
        $this->seller = $seller;
        $this->prices = $prices;

It seems like $prices can be null. However, the property $prices is declared as array. Maybe change the type of the property to array|null or add a type check?

    }

    public function getUniqueId()
    {
        return $this->getId();
    }

    /**
     * @return int|string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @return bool
     */
    public function hasPrices()
    {
        return $this->prices !== null;
    }

    /**
     * @return PriceInterface[]
     */
    public function getPrices()
    {
        return $this->prices;
    }

    /**
     * @param PriceInterface[] $prices
     */
    public function setPrices(array $prices)
    {
        if ($this->hasPrices()) {
            throw new \Exception('cannot reassign prices for plan');
        }
        $this->prices = $prices;
    }

    /**
     * Calculate charges for given action.
     * @param ActionInterface $action
     * @return Charge[]|ChargeInterface[]
     */
    public function calculateCharges(ActionInterface $action)
    {
        $result = [];
        foreach ($this->prices as $price) {
            $charges = $price->calculateCharges($action);
            if ($charges) {
                $result = array_merge($result, $charges);
            }
        }

        return $result;
    }

    public function jsonSerialize()
    {
        return get_object_vars($this);
    }

    /**
     * @return CustomerInterface
     */
    public function getSeller(): ?CustomerInterface
    {
        return $this->seller;
    }
}