Item::setIdentifier() - Code Metrics - Inspection of "Use interface for item" - Lenius/basket - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by Carsten

created 2019-01-25 18:33 UTC

Item::setIdentifier() A

↳ Parent: Item

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/**
 * This file is part of Lenius Basket, a PHP package to handle
 * your shopping basket.
 *
 * Copyright (c) 2017 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 2017 Lenius.
 *
 * @version production
 *
 * @link https://github.com/lenius/basket
 */

namespace Lenius\Basket;

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

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

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

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

        $item['tax'] = isset($item['tax']) ? $item['tax'] : 0;

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

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

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

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

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

    /**
     * Return the total tax for this item.
     *
     * @return float
     */
    public function tax()
    {
        $price = $this->totalPrice();
        $quantity = $this->quantity;

        return $this->tax->rate($price * $quantity);
    }

    /**
     * Return the total price for this item.
     *
     * @return float
     */
    private function totalPrice()
    {
        $price = $this->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 Whether or not to include tax
     *
     * @return float The total, as a float
     */
    public function total($includeTax = true)
    {
        $price = $this->totalPrice();

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

        return $price * $this->quantity;
    }

    /**
     * Return the total weight of the item.
     *
     * @return float The weight, as a float
     */
    public function weight()
    {
        $weight = $this->weight;

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

        return $weight * $this->quantity;
    }

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

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

        return $price;
    }

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

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

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


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

Lenius / basket

Pull Request — master (#4)

Item::setIdentifier() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like