hiqdev / billing-hiapi

src/tools/MonthlyBillQuantityFixer.php

<?php

namespace hiqdev\billing\hiapi\tools;

use hiqdev\billing\hiapi\charge\Generalizer;
use hiqdev\billing\hiapi\type\TypeSemantics;
use hiqdev\php\billing\bill\BillInterface;
use hiqdev\php\billing\charge\GeneralizerInterface;
use hiqdev\php\units\Quantity;
use hiqdev\php\units\QuantityInterface;
use hiqdev\php\units\Unit;

/**
 * Normally, when monthly charges are put in the single bill, the bill quantity
 * increases accordingly. But it's not the right scenario for monthly bills: all
 * the charges are for the month quantity, but the whole bill is for one month as well.
 *
 * Class MonthlyBillQuantityFixer is applicable only for monthly bills and
 * adjusts the quantity of monthly bills according to the number of days in month.
 *
 * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
 */
final class MonthlyBillQuantityFixer
{
    /**
     * @var Generalizer
     */
    private $generalizer;

    /**
     * @var TypeSemantics
     */
    private $typeSemantics;

    public function __construct(
        GeneralizerInterface $generalizer,
        TypeSemantics $typeSemantics
    ) {
        $this->generalizer = $generalizer;

$generalizer is of type hiqdev\php\billing\charge\GeneralizerInterface, but the property $generalizer was declared to be of type hiqdev\billing\hiapi\charge\Generalizer. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        $this->typeSemantics = $typeSemantics;
    }

    /**
     * @param BillInterface $bill
     */
    public function __invoke($bill): void
    {
        if ($this->typeSemantics->isMonthly($bill->getType())) {
            $bill->setQuantity($this->calculateMonthlyQuantity($bill));
        }
    }

    private function calculateMonthlyQuantity(BillInterface $bill): QuantityInterface
    {
        $res = null;
        foreach ($bill->getCharges() as $charge) {
            $amount = $this->generalizer->generalizeQuantity($charge);
            if (!$amount->getUnit()->isConvertible(Unit::days())) {
                continue;
            }
            if ($res === null || $amount->compare($res)>0) {

$res of type null is incompatible with the type hiqdev\php\units\QuantityInterface expected by parameter $other of hiqdev\php\units\QuantityInterface::compare().

                $res = $amount;
            }
        }
        return $res ?? Quantity::create('days', 1);
    }
}