BasketComponent::removeFromBasket() - Code Metrics - Inspection of "Improve all project template" - itstructure/yii2-template-simple - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b39695...9f262c )

by Andrey

created 2020-08-03 15:28 UTC

BasketComponent::removeFromBasket() A

↳ Parent: BasketComponent

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	1
dl	0
loc	26
rs	9.1928
c	0
b	0
f	0

<?php

namespace app\components;

use Yii;
use yii\web\Session;
use yii\base\Component;
use yii\db\ActiveRecordInterface;

/**
 * Class BasketComponent
 *
 * @property Session $sessionManager
 *
 * @package app\components
 */
class BasketComponent extends Component
{
    /**
     * Session manager.
     *
     * @var Session
     */
    private $sessionManager;

    /**
     * @var string
     */
    private $containerName = 'basket';

    /**
     * @var string|ActiveRecordInterface
     */
    private $modelClass;

    /**
     * @var string
     */
    private $modelPrimaryKey = 'id';

    /**
     * @var string
     */
    private $modelAmountKey = 'price';

    /**
     * @var array
     */
    private $modelAdditionKeys = [];

    /**
     * @var null|array
     */
    private $sessionData = null;

    /**
     * Initialize.
     */
    public function init()
    {
        if (null === $this->sessionManager) {
            $this->setSessionManager(Yii::$app->session);
        }
    }

    /**
     * Set sessionManager.
     *
     * @param Session $sessionManager
     */
    public function setSessionManager(Session $sessionManager): void
    {
        $this->sessionManager = $sessionManager;
    }

    /**
     * @param string $name
     */
    public function setContainerName(string $name): void
    {
        $this->containerName = $name;
    }

    /**
     * @param string $modelClass
     * @throws \Exception
     */
    public function setModelClass(string $modelClass): void
    {
        $userModelInterfaces = class_implements($modelClass);

        if (!isset($userModelInterfaces[ActiveRecordInterface::class])) {
            throw new \Exception('Model class must be implemented from "'.ActiveRecordInterface::class.'".');
        }

        $this->modelClass = $modelClass;
    }

    /**
     * @param string $modelPrimaryKey
     */
    public function setModelPrimaryKey(string $modelPrimaryKey): void
    {
        $this->modelPrimaryKey = $modelPrimaryKey;
    }

    /**
     * @param string $modelAmountKey
     */
    public function setModelAmountKey(string $modelAmountKey): void
    {
        $this->modelAmountKey = $modelAmountKey;
    }

    /**
     * @param array $modelAdditionKeys
     */
    public function setModelAdditionKeys(array $modelAdditionKeys): void
    {
        $this->modelAdditionKeys = $modelAdditionKeys;
    }

    /**
     * @return mixed
     */
    public function retrieveSessionData()
    {
        if ($this->sessionData == null) {
            $this->sessionData = $this->sessionManager->get($this->containerName);
        }

        return $this->sessionData;
    }

    /**
     * @param array|null $sessionData
     */
    public function fillSessionData(array $sessionData = null): void
    {
        $this->sessionManager->set($this->containerName, $sessionData);

        $this->sessionData = $sessionData;
    }

    /**
     * @param int $modelId
     * @param int $count
     * @return bool
     * @throws \Exception
     */
    public function putToBasket(int $modelId, int $count = 1): bool
    {
        $sessionData = $this->retrieveSessionData();

        if (!empty($sessionData) && !is_array($sessionData)) {
            throw new \Exception('Session data must be an array.');
        }

        if (empty($sessionData)) {
            $sessionData = [
                $modelId => $count
            ];

        } else if (isset($sessionData[$modelId])) {
            $sessionData[$modelId] += $count;

        } else {
            $sessionData[$modelId] = $count;
        }

        $this->fillSessionData($sessionData);

        $result = $this->retrieveSessionData();

        if (empty($result)) {
            throw new \Exception('Session storage is not full.');
        }

        if (!isset($result[$modelId])) {
            throw new \Exception('Order item is not set to storage.');
        }

        return true;
    }

    /**
     * @param int $modelId
     * @param int $count
     * @return bool
     * @throws \Exception
     */
    public function setCountInBasket(int $modelId, int $count): bool
    {
        $sessionData = $this->retrieveSessionData();

        if (empty($sessionData)) {
            throw new \Exception('Session storage is empty.');
        }

        if (!is_array($sessionData)) {
            throw new \Exception('Session data must be an array.');
        }

        if (!isset($sessionData[$modelId])) {
            throw new \Exception('Order item not found in a storage.');
        }

        $sessionData[$modelId] = $count;

        $this->fillSessionData($sessionData);

        return true;
    }

    /**
     * @param int $modelId
     * @return bool
     * @throws \Exception
     */
    public function removeFromBasket(int $modelId): bool
    {
        $sessionData = $this->retrieveSessionData();

        if (empty($sessionData)) {
            throw new \Exception('Session storage is already empty.');
        }

        if (!is_array($sessionData)) {
            throw new \Exception('Session data must be an array.');
        }

        if (!isset($sessionData[$modelId])) {
            throw new \Exception('Order item not found in a storage.');
        }

        if (count($sessionData) > 1) {
            unset($sessionData[$modelId]);
            $this->fillSessionData($sessionData);

        } else {
            $this->clearBasket();
        }

        return true;
    }

    /**
     * Clear basket.
     */
    public function clearBasket(): void
    {
        $this->sessionManager->remove($this->containerName);
        $this->sessionData = null;
    }

    /**
     * @return int
     */
    public function getTotalCount(): int
    {
        $sessionData = $this->retrieveSessionData();

        if (empty($sessionData)) {
            return 0;
        }

        return array_sum(array_values($sessionData));
    }

    /**
     * @return float
     */
    public function getTotalAmount(): float
    {
        return $this->calculateTotalAmount($this->getModelItems());
    }

    /**
     * @param array $modelItems
     * @return float
     */
    public function calculateTotalAmount(array $modelItems): float
    {
        $sessionData = $this->retrieveSessionData();

        if (empty($sessionData)) {
            return 0;
        }

        $amount = 0;

        foreach ($modelItems as $item) {
            $amount += ($item->{$this->modelAmountKey} * $sessionData[$item->{$this->modelPrimaryKey}]);
        }

        return $amount;
    }

    /**
     * @return array
     */
    public function getModelItems(): array
    {
        $sessionData = $this->retrieveSessionData();

        if (empty($sessionData)) {
            return [];
        }

        $modelClass = $this->modelClass;

        $modelItems = [];
        $selection = [$this->modelPrimaryKey, $this->modelAmountKey];

        foreach ($this->modelAdditionKeys as $additionKey) {
            $selection[] = $additionKey;
        }

        $models = $modelClass::find()->where(['in', $this->modelPrimaryKey, array_keys($sessionData)])->select($selection)->all();

        foreach ($models as $model) {
            $modelItems[$model->{$this->modelPrimaryKey}] = $model;
        }

        return $modelItems;
    }
}


1			<?php
2
3			namespace app\components;
4
5			use Yii;
6			use yii\web\Session;
7			use yii\base\Component;
8			use yii\db\ActiveRecordInterface;
9
10			/**
11			* Class BasketComponent
12			*
13			* @property Session $sessionManager
14			*
15			* @package app\components
16			*/
17			class BasketComponent extends Component
18			{
19			/**
20			* Session manager.
21			*
22			* @var Session
23			*/
24			private $sessionManager;
25
26			/**
27			* @var string
28			*/
29			private $containerName = 'basket';
30
31			/**
32			* @var string\|ActiveRecordInterface
33			*/
34			private $modelClass;
35
36			/**
37			* @var string
38			*/
39			private $modelPrimaryKey = 'id';
40
41			/**
42			* @var string
43			*/
44			private $modelAmountKey = 'price';
45
46			/**
47			* @var array
48			*/
49			private $modelAdditionKeys = [];
50
51			/**
52			* @var null\|array
53			*/
54			private $sessionData = null;
55
56			/**
57			* Initialize.
58			*/
59			public function init()
60			{
61			if (null === $this->sessionManager) {
62			$this->setSessionManager(Yii::$app->session);
63			}
64			}
65
66			/**
67			* Set sessionManager.
68			*
69			* @param Session $sessionManager
70			*/
71			public function setSessionManager(Session $sessionManager): void
72			{
73			$this->sessionManager = $sessionManager;
74			}
75
76			/**
77			* @param string $name
78			*/
79			public function setContainerName(string $name): void
80			{
81			$this->containerName = $name;
82			}
83
84			/**
85			* @param string $modelClass
86			* @throws \Exception
87			*/
88			public function setModelClass(string $modelClass): void
89			{
90			$userModelInterfaces = class_implements($modelClass);
91
92			if (!isset($userModelInterfaces[ActiveRecordInterface::class])) {
93			throw new \Exception('Model class must be implemented from "'.ActiveRecordInterface::class.'".');
94			}
95
96			$this->modelClass = $modelClass;
97			}
98
99			/**
100			* @param string $modelPrimaryKey
101			*/
102			public function setModelPrimaryKey(string $modelPrimaryKey): void
103			{
104			$this->modelPrimaryKey = $modelPrimaryKey;
105			}
106
107			/**
108			* @param string $modelAmountKey
109			*/
110			public function setModelAmountKey(string $modelAmountKey): void
111			{
112			$this->modelAmountKey = $modelAmountKey;
113			}
114
115			/**
116			* @param array $modelAdditionKeys
117			*/
118			public function setModelAdditionKeys(array $modelAdditionKeys): void
119			{
120			$this->modelAdditionKeys = $modelAdditionKeys;
121			}
122
123			/**
124			* @return mixed
125			*/
126			public function retrieveSessionData()
127			{
128			if ($this->sessionData == null) {
129			$this->sessionData = $this->sessionManager->get($this->containerName);
130			}
131
132			return $this->sessionData;
133			}
134
135			/**
136			* @param array\|null $sessionData
137			*/
138			public function fillSessionData(array $sessionData = null): void
139			{
140			$this->sessionManager->set($this->containerName, $sessionData);
141
142			$this->sessionData = $sessionData;
143			}
144
145			/**
146			* @param int $modelId
147			* @param int $count
148			* @return bool
149			* @throws \Exception
150			*/
151			public function putToBasket(int $modelId, int $count = 1): bool
152			{
153			$sessionData = $this->retrieveSessionData();
154
155			if (!empty($sessionData) && !is_array($sessionData)) {
156			throw new \Exception('Session data must be an array.');
157			}
158
159			if (empty($sessionData)) {
160			$sessionData = [
161			$modelId => $count
162			];
163
164			} else if (isset($sessionData[$modelId])) {
165			$sessionData[$modelId] += $count;
166
167			} else {
168			$sessionData[$modelId] = $count;
169			}
170
171			$this->fillSessionData($sessionData);
172
173			$result = $this->retrieveSessionData();
174
175			if (empty($result)) {
176			throw new \Exception('Session storage is not full.');
177			}
178
179			if (!isset($result[$modelId])) {
180			throw new \Exception('Order item is not set to storage.');
181			}
182
183			return true;
184			}
185
186			/**
187			* @param int $modelId
188			* @param int $count
189			* @return bool
190			* @throws \Exception
191			*/
192			public function setCountInBasket(int $modelId, int $count): bool
193			{
194			$sessionData = $this->retrieveSessionData();
195
196			if (empty($sessionData)) {
197			throw new \Exception('Session storage is empty.');
198			}
199
200			if (!is_array($sessionData)) {
201			throw new \Exception('Session data must be an array.');
202			}
203
204			if (!isset($sessionData[$modelId])) {
205			throw new \Exception('Order item not found in a storage.');
206			}
207
208			$sessionData[$modelId] = $count;
209
210			$this->fillSessionData($sessionData);
211
212			return true;
213			}
214
215			/**
216			* @param int $modelId
217			* @return bool
218			* @throws \Exception
219			*/
220			public function removeFromBasket(int $modelId): bool
221			{
222			$sessionData = $this->retrieveSessionData();
223
224			if (empty($sessionData)) {
225			throw new \Exception('Session storage is already empty.');
226			}
227
228			if (!is_array($sessionData)) {
229			throw new \Exception('Session data must be an array.');
230			}
231
232			if (!isset($sessionData[$modelId])) {
233			throw new \Exception('Order item not found in a storage.');
234			}
235
236			if (count($sessionData) > 1) {
237			unset($sessionData[$modelId]);
238			$this->fillSessionData($sessionData);
239
240			} else {
241			$this->clearBasket();
242			}
243
244			return true;
245			}
246
247			/**
248			* Clear basket.
249			*/
250			public function clearBasket(): void
251			{
252			$this->sessionManager->remove($this->containerName);
253			$this->sessionData = null;
254			}
255
256			/**
257			* @return int
258			*/
259			public function getTotalCount(): int
260			{
261			$sessionData = $this->retrieveSessionData();
262
263			if (empty($sessionData)) {
264			return 0;
265			}
266
267			return array_sum(array_values($sessionData));
268			}
269
270			/**
271			* @return float
272			*/
273			public function getTotalAmount(): float
274			{
275			return $this->calculateTotalAmount($this->getModelItems());
276			}
277
278			/**
279			* @param array $modelItems
280			* @return float
281			*/
282			public function calculateTotalAmount(array $modelItems): float
283			{
284			$sessionData = $this->retrieveSessionData();
285
286			if (empty($sessionData)) {
287			return 0;
288			}
289
290			$amount = 0;
291
292			foreach ($modelItems as $item) {
293			$amount += ($item->{$this->modelAmountKey} * $sessionData[$item->{$this->modelPrimaryKey}]);
294			}
295
296			return $amount;
297			}
298
299			/**
300			* @return array
301			*/
302			public function getModelItems(): array
303			{
304			$sessionData = $this->retrieveSessionData();
305
306			if (empty($sessionData)) {
307			return [];
308			}
309
310			$modelClass = $this->modelClass;
311
312			$modelItems = [];
313			$selection = [$this->modelPrimaryKey, $this->modelAmountKey];
314
315			foreach ($this->modelAdditionKeys as $additionKey) {
316			$selection[] = $additionKey;
317			}
318
319			$models = $modelClass::find()->where(['in', $this->modelPrimaryKey, array_keys($sessionData)])->select($selection)->all();
320
321			foreach ($models as $model) {
322			$modelItems[$model->{$this->modelPrimaryKey}] = $model;
323			}
324
325			return $modelItems;
326			}
327			}
328

itstructure / yii2-template-simple

Push — master ( b39695...9f262c )

BasketComponent::removeFromBasket() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like