hiqdev / billing-hiapi

src/plan/PlanRepository.php

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

use hiqdev\php\billing\action\ActionInterface;
use hiqdev\php\billing\Exception\EntityNotFoundException;
use hiqdev\php\billing\order\OrderInterface;
use hiqdev\php\billing\plan\Plan;
use hiqdev\php\billing\plan\PlanInterface;
use hiqdev\php\billing\plan\PlanRepositoryInterface;
use hiqdev\php\billing\price\PriceInterface;
use hiqdev\yii\DataMapper\models\relations\Bucket;
use hiqdev\yii\DataMapper\query\Specification;
use hiqdev\yii\DataMapper\repositories\BaseRepository;

class PlanRepository extends BaseRepository implements PlanRepositoryInterface
{
    /** {@inheritdoc} */
    public $queryClass = PlanQuery::class;

    /**
     * @param ActionInterface $action
     * @return PlanInterface
     */
    public function findByAction(ActionInterface $action)
    {
        $client_id = $action->getCustomer()->getId();
        $seller = $action->getCustomer()->getSeller()->getLogin();
        $type = $action->getTarget()->getType();

        $spec = $this->createSpecification()
            ->with('prices')
            ->where([
                'type-name' => $type,
                'available_for' => [
                    'client_id' => $client_id,
                    'seller'    => $seller,
                ],
            ]);

        return $this->findOne($spec);

The expression return $this->findOne($spec) could also return false which is incompatible with the documented return type hiqdev\php\billing\plan\PlanInterface. Did you maybe forget to handle an error condition?

    }

    /**
     * @param OrderInterface $order
     * @return Plan[]|PlanInterface[]
     */
    public function findByOrder(OrderInterface $order)
    {
        return array_map([$this, 'findByAction'], $order->getActions());
    }

    public function findByIds(array $ids): array
    {
        $spec = $this->createSpecification()
            ->with('prices')
            ->where(['id' => $ids]);

        return $this->findAll($spec);
    }

    protected function joinPrices(&$rows)
    {
        $bucket = Bucket::fromRows($rows, 'id');
        $spec = $this->createSpecification()->where(['plan-id' => $bucket->getKeys()]);
        $prices = $this->getRepository(PriceInterface::class)->queryAll($spec);
        $bucket->fill($prices, 'plan.id', 'id');
        $bucket->pour($rows, 'prices');
    }

    public function getById(int $id): PlanInterface
    {
        $plans = $this->findByIds([$id]);
        if (count($plans) === 0) {
            throw new EntityNotFoundException(sprintf('Could not find Plan %s', $id));
        }

        return reset($plans);
    }
}