Item::getQuantity() - Code Metrics - Inspection of "Update to php 8 (#15)" - Lenius/basket - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1f9686...6724e4 )

by Carsten

created 2022-05-25 14:50 UTC

Item::getQuantity() A

↳ Parent: Item

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

/**
 * This file is part of Lenius Basket, a PHP package to handle
 * your shopping basket.
 *
 * Copyright (c) 2022 Lenius.
 * https://github.com/lenius/basket
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Carsten Jonstrup<[email protected]>
 * @copyright 2022 Lenius.
 *
 * @version production
 *
 * @see https://github.com/lenius/basket
 */

namespace Lenius\Basket;

/**
 * Class Item.
 *
 * @property string $identifier
 * @property float  $price
 * @property int    $quantity
 * @property float  $weight
 */
class Item implements ItemInterface
{
    /** @var string */
    protected string $identifier;

    /** @var Tax */
    protected Tax $tax;

    /** @var array */
    protected array $data = [];

    /**
     * Construct the item.
     *
     * @param array $item
     */
    public function __construct(array $item)
    {
        foreach ($item as $key => $value) {
            $this->data[$key] = $value;
        }

        $item['tax'] = $item['tax'] ?? 0;

        $this->tax = new Tax($item['tax']);
    }

    /**
     * Set identifier.
     *
     * @param string $identifier
     */
    public function setIdentifier(string $identifier): void
    {
        $this->identifier = $identifier;
    }

    /**
     * Return the value of protected methods.
     *
     * @param string $param
     *
     * @return mixed
     */
    public function __get(string $param)
    {
        return 'identifier' === $param ? $this->identifier : $this->data[$param];
    }

    /**
     * Update data array using set magic method.
     *
     * @param mixed $param
     * @param mixed $value
     */
    public function __set(mixed $param, mixed $value): void
    {
        $this->data[$param] = $value;

        if ('tax' == $param) {
            $this->tax = new Tax(floatval($value));
        }
    }

    /**
     * Return the total tax for this item.
     *
     * @return float
     */
    public function tax(): float
    {
        return $this->tax->rate($this->totalPrice() * $this->getQuantity());
    }

    /**
     * Return the total price for this item.
     *
     * @return float
     */
    private function totalPrice(): float
    {
        $price = $this->data['price'];

        if ($this->hasOptions()) {
            foreach ($this->data['options'] as $item) {
                if (array_key_exists('price', $item)) {
                    $price += $item['price'];
                }
            }
        }

        return $price;
    }

    /**
     * Return the total of the item, with or without tax.
     *
     * @param bool $includeTax
     *
     * @return float
     */
    public function total(bool $includeTax = true): float
    {
        $price = $this->totalPrice();

        if ($includeTax) {
            $price = $this->tax->add($price);
        }

        return ($price * $this->getQuantity());
    }

    /**
     * Return the total weight of the item.
     *
     * @return float
     */
    public function weight(): float
    {
        $weight = $this->data['weight'];

        if ($this->hasOptions()) {
            foreach ($this->data['options'] as $item) {
                if (array_key_exists('weight', $item)) {
                    $weight += $item['weight'];
                }
            }
        }

        return (float) ($weight * $this->getQuantity());
    }

    /**
     * Return the total of the item, with or without tax.
     *
     * @param bool $includeTax
     *
     * @return float
     */
    public function single(bool $includeTax = true): float
    {
        $price = $this->totalPrice();

        if ($includeTax) {
            $price = $this->tax->add($price);
        }

        return $price;
    }

    /**
     * Update a single key for this item, or multiple.
     *
     * @param mixed $key
     * @param mixed|null $value
     */
    public function update(mixed $key, mixed $value = null): void
    {
        if ($key instanceof ItemInterface) {
            foreach ($key->toArray() as $updateKey => $updateValue) {
                $this->update($updateKey, $updateValue);
            }
        } else {
            if ('tax' == $key && is_numeric($value)) {
                $this->tax = new Tax((float)$value);
            } else {
                // update the item
                $this->data[$key] = $value;
            }
        }
    }

    /**
     * Check if this item has options.
     *
     * @return bool
     */
    public function hasOptions(): bool
    {
        return array_key_exists('options', $this->data) && ! empty($this->data['options']);
    }

    /**
     * Convert the item into an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        return $this->data;
    }

    /**
     * Return quantity
     *
     * @return int
     */
    public function getQuantity(): int
    {
        return $this->data['quantity'];
    }

    /**
     * Set quantity
     *
     * @param int $quantity
     *
     * @return void
     */
    public function setQuantity(int $quantity): void
    {
        $this->data['quantity'] = $quantity;
    }
}


1		<?php
2
3		/**
4		* This file is part of Lenius Basket, a PHP package to handle
5		* your shopping basket.
6		*
7		* Copyright (c) 2022 Lenius.
8		* https://github.com/lenius/basket
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*
13		* @author Carsten Jonstrup<[email protected]>
14		* @copyright 2022 Lenius.
15		*
16		* @version production
17		*
18		* @see https://github.com/lenius/basket
19		*/
20
21		namespace Lenius\Basket;
22
23		/**
24		* Class Item.
25		*
26		* @property string $identifier
27		* @property float $price
28		* @property int $quantity
29		* @property float $weight
30		*/
31		class Item implements ItemInterface
32		{
33		/** @var string */
34		protected string $identifier;
35
36		/** @var Tax */
37		protected Tax $tax;
38
39		/** @var array */
40		protected array $data = [];
41
42		/**
43		* Construct the item.
44		*
45		* @param array $item
46		*/
47	26	public function __construct(array $item)
48		{
49	26	foreach ($item as $key => $value) {
50	26	$this->data[$key] = $value;
51		}
52
53	26	$item['tax'] = $item['tax'] ?? 0;
54
55	26	$this->tax = new Tax($item['tax']);
56		}
57
58		/**
59		* Set identifier.
60		*
61		* @param string $identifier
62		*/
63	18	public function setIdentifier(string $identifier): void
64		{
65	18	$this->identifier = $identifier;
66		}
67
68		/**
69		* Return the value of protected methods.
70		*
71		* @param string $param
72		*
73		* @return mixed
74		*/
75	18	public function __get(string $param)
76		{
77	18	return 'identifier' === $param ? $this->identifier : $this->data[$param];
78		}
79
80		/**
81		* Update data array using set magic method.
82		*
83		* @param mixed $param
84		* @param mixed $value
85		*/
86	19	public function __set(mixed $param, mixed $value): void
87		{
88	19	$this->data[$param] = $value;
89
90	19	if ('tax' == $param) {
91	1	$this->tax = new Tax(floatval($value));
92		}
93		}
94
95		/**
96		* Return the total tax for this item.
97		*
98		* @return float
99		*/
100	3	public function tax(): float
101		{
102	3	return $this->tax->rate($this->totalPrice() * $this->getQuantity());
103		}
104
105		/**
106		* Return the total price for this item.
107		*
108		* @return float
109		*/
110	11	private function totalPrice(): float
111		{
112	11	$price = $this->data['price'];
113
114	11	if ($this->hasOptions()) {
115	3	foreach ($this->data['options'] as $item) {
116	3	if (array_key_exists('price', $item)) {
117	3	$price += $item['price'];
118		}
119		}
120		}
121
122	11	return $price;
123		}
124
125		/**
126		* Return the total of the item, with or without tax.
127		*
128		* @param bool $includeTax
129		*
130		* @return float
131		*/
132	7	public function total(bool $includeTax = true): float
133		{
134	7	$price = $this->totalPrice();
135
136	7	if ($includeTax) {
137	7	$price = $this->tax->add($price);
138		}
139
140	7	return ($price * $this->getQuantity());
141		}
142
143		/**
144		* Return the total weight of the item.
145		*
146		* @return float
147		*/
148	4	public function weight(): float
149		{
150	4	$weight = $this->data['weight'];
151
152	4	if ($this->hasOptions()) {
153	3	foreach ($this->data['options'] as $item) {
154	3	if (array_key_exists('weight', $item)) {
155	2	$weight += $item['weight'];
156		}
157		}
158		}
159
160	4	return (float) ($weight * $this->getQuantity());
161		}
162
163		/**
164		* Return the total of the item, with or without tax.
165		*
166		* @param bool $includeTax
167		*
168		* @return float
169		*/
170	1	public function single(bool $includeTax = true): float
171		{
172	1	$price = $this->totalPrice();
173
174	1	if ($includeTax) {
175	1	$price = $this->tax->add($price);
176		}
177
178	1	return $price;
179		}
180
181		/**
182		* Update a single key for this item, or multiple.
183		*
184		* @param mixed $key
185		* @param mixed\|null $value
186		*/
187	4	public function update(mixed $key, mixed $value = null): void
188		{
189	4	if ($key instanceof ItemInterface) {
190	1	foreach ($key->toArray() as $updateKey => $updateValue) {
191	1	$this->update($updateKey, $updateValue);
192		}
193		} else {
194	4	if ('tax' == $key && is_numeric($value)) {
195	2	$this->tax = new Tax((float)$value);
196		} else {
197		// update the item
198	2	$this->data[$key] = $value;
199		}
200		}
201		}
202
203		/**
204		* Check if this item has options.
205		*
206		* @return bool
207		*/
208	17	public function hasOptions(): bool
209		{
210	17	return array_key_exists('options', $this->data) && ! empty($this->data['options']);
211		}
212
213		/**
214		* Convert the item into an array.
215		*
216		* @return array
217		*/
218	18	public function toArray(): array
219		{
220	18	return $this->data;
221		}
222
223		/**
224		* Return quantity
225		*
226		* @return int
227		*/
228	16	public function getQuantity(): int
229		{
230	16	return $this->data['quantity'];
231		}
232
233		/**
234		* Set quantity
235		*
236		* @param int $quantity
237		*
238		* @return void
239		*/
240	2	public function setQuantity(int $quantity): void
241		{
242	2	$this->data['quantity'] = $quantity;
243		}
244		}
245

Lenius / basket

Push — master ( 1f9686...6724e4 )

Item::getQuantity() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like