CartCalculator::handle() - Code Metrics - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

CartCalculator::handle() A
last analyzed 2020-11-24 16:48 UTC

↳ Parent: CartCalculator

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	0
cts	9
cp	0
rs	9.8333
c	0
b	0
f	0
cc	3
nc	2
nop	1
crap	12

<?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;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * {@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;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $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);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                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);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        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.'));
        }
    }
}


1			<?php
2			/**
3			* Finance module for HiPanel
4			*
5			* @link https://github.com/hiqdev/hipanel-module-finance
6			* @package hipanel-module-finance
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\modules\finance\cart;
12
13			use hipanel\modules\finance\logic\Calculator;
14			use hipanel\modules\finance\models\Calculation;
			0 ignored issues – show Bug introduced 2016-09-13 16:41 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `hipanel\modules\finance\cart\Calculation`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
15			use hipanel\modules\finance\models\Value;
16			use hiqdev\yii2\cart\ShoppingCart;
17			use Yii;
18			use yii\web\UnprocessableEntityHttpException;
19			use yz\shoppingcart\CartActionEvent;
20
21			/**
22			* Class CartCalculator provides API to calculate [[cart]] positions value.
23			*
24			* Usage:
25			*
26			* ```php
27			* $calculator = new CartCalculator($this->cart);
28			*
29			* $calculator->run(); // will calculate prices for all cart positions and update them
30			* ```
31			*
32			* Also can be bound to some cart event as handler:
33			*
34			* ```php
35			* $cart->on(Cart::EVENT_UPDATE, [CartCalculator::class, 'handle']);
36			* ```
37			*/
38			final class CartCalculator extends Calculator
39			{
40			/**
41			* @var AbstractCartPosition[]
42			*/
43			protected $models;
44
45			/**
46			* @var ShoppingCart
47			*/
48			public $cart;
49
50			/**
51			* @var CartActionEvent
52			*/
53			public $event;
54			/**
55			* @var string[]
56			*/
57			private $positionsBeingRemoved = [];
58
59			/**
60			* Creates the instance of the object and runs the calculation.
61			*
62			* @param CartActionEvent $event The event
63			* @void
64			*/
65			public static function handle($event)
66			{
67			/** @var ShoppingCart $cart */
68			$cart = $event->sender;
69
70			$calculator = new static($cart);
71			if ($event->action === CartActionEvent::ACTION_BEFORE_REMOVE && $event->position !== null) {
72			$calculator->positionsBeingRemoved[] = $event->position->getId();
73			}
74
75			/** @noinspection UnusedFunctionResultInspection */
76			$calculator->execute();
77			}
78
79			/**
80			* @param ShoppingCart $cart
81			*/
82			public function __construct(ShoppingCart $cart)
83			{
84			$this->cart = $cart;
85
86			parent::__construct($this->cart->positions);
			0 ignored issues – show Documentation introduced 2020-06-18 16:42 UTC by Report Bug Copy Issue Report `$this->cart->positions` is of type `array<integer,object<hiq...CartPositionInterface>>`, but the function expects a `array<integer,object<yii\base\Model>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
87			}
88
89			/**
90			* {@inheritdoc}
91			*/
92			public function execute()
93			{
94			// Do not try to calculate position that is being removed
95			foreach ($this->positionsBeingRemoved as $id) {
96			unset($this->models[$id]);
97			}
98
99			try {
100			parent::execute();
101			} catch (UnprocessableEntityHttpException $e) {
102			throw CartIsBrokenException::forCart(
103			$this->cart,
104			Yii::t('hipanel:finance', 'Failed to calculate cart: {reason}', ['reason' => $e->getMessage()])
105			);
106			}
107
108			$this->applyCalculations();
109			return $this->calculations;
110			}
111
112			/**
113			* Updates positions using the calculations provided with [[getCalculation]].
114			*/
115			private function applyCalculations()
116			{
117			foreach ($this->models as $position) {
118			$id = $position->id;
			0 ignored issues – show Documentation introduced 2016-06-24 07:57 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\f...t\AbstractCartPosition>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
119			$calculation = $this->getCalculation($id);
120			if (!$calculation instanceof Calculation) {
121			Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because of failed value calculation. Normally this should never happen.', 'hipanel.cart');
122			$this->cart->removeById($position->id);
			0 ignored issues – show Documentation introduced 2016-06-24 07:57 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\f...t\AbstractCartPosition>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
123			break;
124			}
125
126			$value = $this->getValue($position, $calculation);
127			$this->ensureCurrencyIsNotConflictingWithCart($position, $value);
128
129			$position->setPrice($value->price);
130			$position->setValue($value->value);
131			$position->setCurrency($value->currency);
132			}
133			}
134
135			private function getValue(AbstractCartPosition $position, Calculation $calculation): Value
136			{
137			$currency = Yii::$app->params['currency'];
138
139			/** @var Value $value */
140			$value = $calculation->forCurrency($currency);
141			if (!$value instanceof Value) {
142			Yii::error('Cart position "' . $position->getName() . '" was removed from the cart because calculation for currency "' . $value->currency . '" is not available', 'hipanel.cart');
143			$this->cart->removeById($position->id);
			0 ignored issues – show Documentation introduced 2016-09-30 15:10 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\f...t\AbstractCartPosition>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
144			}
145
146			return $value;
147			}
148
149			private function ensureCurrencyIsNotConflictingWithCart(AbstractCartPosition $position, Value $value): void
150			{
151			if ($this->cart->getCurrency() && $value->currency !== $this->cart->getCurrency()) {
152			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.'));
153			}
154			}
155			}
156

hiqdev / hipanel-module-finance

CartCalculator::handle() A last analyzed 2020-11-24 16:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CartCalculator::handle() A
last analyzed 2020-11-24 16:48 UTC