hiqdev / php-billing

src/tools/Aggregator.php

<?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\tools;

use hiqdev\php\billing\bill\Bill;
use hiqdev\php\billing\bill\BillInterface;
use hiqdev\php\billing\charge\ChargeInterface;
use hiqdev\php\billing\charge\GeneralizerInterface;
use hiqdev\php\units\QuantityInterface;
use Money\Money;

/**
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class Aggregator implements AggregatorInterface
{
    /**
     * @var GeneralizerInterface
     */
    protected $generalizer;

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

    /**
     * Aggregates given Charges to Bills. Then aggregates them again with DB.
     * @param ChargeInterface[]|ChargeInterface[][] $charges
     * @return BillInterface[]
     */
    public function aggregateCharges(array $charges): array
    {
        $bills = [];
        foreach ($charges as $charge) {
            if (is_array($charge)) {
                $others = $this->aggregateCharges($charge);
            } elseif ($charge instanceof ChargeInterface) {
                $others = [$this->generalizer->createBill($charge)];
            } else {
                var_dump($charge);die;

var_dump($charge) looks like debug code. Are you sure you do not want to remove it?

In this branch, the function will implicitly return null which is incompatible with the type-hinted return array. Consider adding a return statement or allowing null as return value.

Using exit here is not recommended.

                throw new \Exception('not a Charge given to Aggregator');

ThrowNode is not reachable.

            }

            $bills = $this->aggregateBills($bills, $others);
        }

        return $bills;
    }

    /**
     * Aggregate arrays of bills.
     * @param BillInterface[] $bills
     * @param BillInterface[] $others
     * @return BillInterface[]
     */
    protected function aggregateBills(array $bills, array $others): array
    {
        foreach ($others as $bill) {
            $uid = $bill->getUniqueString();
            if (empty($bills[$uid])) {
                $bills[$uid] = $bill;
            } else {
                $bills[$uid] = $this->aggregateBill($bills[$uid], $bill);
            }
        }

        return $bills;
    }

    /**
     * @param BillInterface $first
     * @param BillInterface $other
     * @return BillInterface
     */
    protected function aggregateBill(BillInterface $first, BillInterface $other): BillInterface
    {
        return new Bill(
            $this->aggregateId($first, $other),
            $first->getType(),
            $first->getTime(),
            $this->aggregateSum($first, $other),
            $this->aggregateQuantity($first, $other),
            $first->getCustomer(),
            $first->getTarget(),
            $first->getPlan(),
            array_merge($first->getCharges(), $other->getCharges())
        );
    }

    /**
     * @param BillInterface $first
     * @param BillInterface $other
     * @return string|int|null
     */
    protected function aggregateId(BillInterface $first, BillInterface $other)
    {
        if ($first->getId() === null) {
            return $other->getId();
        }
        if ($other->getId() === null) {
            return $first->getId();
        }
        if ($first->getId() === $other->getId()) {
            return $other->getId();
        }

        throw new AggregationException('cannot aggregate bills with different IDs');
    }

    /**
     * @param BillInterface $first
     * @param BillInterface $other
     * @param ChargeInterface[] $charges
     * @return Money
     */
    protected function aggregateSum(BillInterface $first, BillInterface $other): Money
    {
        return $first->getSum()->add($other->getSum());
    }

    /**
     * @param BillInterface $first
     * @param BillInterface $other
     * @param ChargeInterface[] $charges
     * @return QuantityInterface
     */
    protected function aggregateQuantity(BillInterface $first, BillInterface $other): QuantityInterface
    {
        return $first->getQuantity()->add($other->getQuantity());
    }
}