hiqdev / hipanel-module-finance

src/cart/CartCalculator.php

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\cart;

use hipanel\modules\finance\logic\Calculator;
use hipanel\modules\finance\models\Calculation;
use hipanel\modules\finance\models\Value;
use hiqdev\yii2\cart\ShoppingCart;
use Yii;
use yii\web\UnprocessableEntityHttpException;
use yz\shoppingcart\CartActionEvent;

/**
 * Class CartCalculator provides API to calculate [[cart]] positions value.
 *
 * Usage:
 *
 * ```php
 * $calculator = new CartCalculator($this->cart);
 *
 * $calculator->run(); // will calculate prices for all cart positions and update them
 * ```
 *
 * Also can be bound to some cart event as handler:
 *
 * ```php
 * $cart->on(Cart::EVENT_UPDATE, [CartCalculator::class, 'handle']);
 * ```
 */
final class CartCalculator extends Calculator
{
    /**
     * @var AbstractCartPosition[]
     */
    protected $models;

    /**
     * @var ShoppingCart
     */
    public $cart;

    /**
     * @var CartActionEvent
     */
    public $event;
    /**
     * @var string[]
     */
    private $positionsBeingRemoved = [];

    /**
     * Creates the instance of the object and runs the calculation.
     *
     * @param CartActionEvent $event The event
     * @void
     */
    public static function handle($event)
    {
        /** @var ShoppingCart $cart */
        $cart = $event->sender;

        $calculator = new static($cart);
        if ($event->action === CartActionEvent::ACTION_BEFORE_REMOVE && $event->position !== null) {
            $calculator->positionsBeingRemoved[] = $event->position->getId();
        }

        /** @noinspection UnusedFunctionResultInspection */
        $calculator->execute();
    }

    /**
     * @param ShoppingCart $cart
     */
    public function __construct(ShoppingCart $cart)
    {
        $this->cart = $cart;

        parent::__construct($this->cart->positions);

$this->cart->positions is of type array<integer,object<hiqdev\yii2\cart\CartPositionInterface>>, but the function expects a array<integer,object<yii\base\Model>>.

    }

    /**
     * {@inheritdoc}
     */
    public function execute()
    {
        // Do not try to calculate position that is being removed
        foreach ($this->positionsBeingRemoved as $id) {
            unset($this->models[$id]);
        }

        try {
            parent::execute();
        } catch (UnprocessableEntityHttpException $e) {
            throw CartIsBrokenException::forCart(
                $this->cart,
                Yii::t('hipanel:finance', 'Failed to calculate cart: {reason}', ['reason' => $e->getMessage()])
            );
        }

        $this->applyCalculations();
        return $this->calculations;
    }

    /**
     * Updates positions using the calculations provided with [[getCalculation]].
     */
    private function applyCalculations()
    {
        foreach ($this->models as $position) {
            $id = $position->id;

The property id does not exist on object<hipanel\modules\finance\cart\AbstractCartPosition>. Since you implemented __set, maybe consider adding a @property annotation.

            $calculation = $this->getCalculation($id);
            if (!$calculation instanceof Calculation) {
                Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because of failed value calculation. Normally this should never happen.', 'hipanel.cart');
                $this->cart->removeById($position->id);

The property id does not exist on object<hipanel\modules\finance\cart\AbstractCartPosition>. Since you implemented __get, maybe consider adding a @property annotation.

                break;
            }

            $value = $this->getValue($position, $calculation);
            $this->ensureCurrencyIsNotConflictingWithCart($position, $value);

            $position->setPrice($value->price);
            $position->setValue($value->value);
            $position->setCurrency($value->currency);
        }
    }

    private function getValue(AbstractCartPosition $position, Calculation $calculation): Value
    {
        $currency = Yii::$app->params['currency'];

        /** @var Value $value */
        $value = $calculation->forCurrency($currency);
        if (!$value instanceof Value) {
            Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because calculation for currency "' . $value->currency . '" is not available', 'hipanel.cart');
            $this->cart->removeById($position->id);

The property id does not exist on object<hipanel\modules\finance\cart\AbstractCartPosition>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        return $value;
    }

    private function ensureCurrencyIsNotConflictingWithCart(AbstractCartPosition $position, Value $value): void
    {
        if ($this->cart->getCurrency() && $value->currency !== $this->cart->getCurrency()) {
            throw MultiCurrencyException::forPosition($position, $this->cart, Yii::t('cart', 'Sorry, but now it is impossible to add the position with different currencies to the cart. Pay the current order to add this item to the cart.'));
        }
    }
}