Basket::contents() - Code Metrics - Inspection of "Badge" - Lenius/basket - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a3c41...108cc9 )

by Carsten

created 2016-07-31 11:59 UTC

Basket::contents() A

↳ Parent: Basket

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

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

use InvalidArgumentException;

class Basket
{
    protected $id;

    protected $identifier;
    protected $store;

    protected $currency;

    protected $requiredParams = [
        'id',
        'name',
        'quantity',
        'price',
        'weight',
    ];

    /**
     * Basket constructor.
     *
     * @param StorageInterface    $store      The interface for storing the cart data
     * @param IdentifierInterface $identifier The interface for storing the identifier
     */
    public function __construct(StorageInterface $store, IdentifierInterface $identifier)
    {
        $this->store = $store;
        $this->identifier = $identifier;

        // Generate/retrieve identifier
        $this->id = $this->identifier->get();

        // Restore the cart from a saved version
        if (method_exists($this->store, 'restore')) {
            $this->store->restore();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        // Let our storage class know which cart we're talking about
        $this->store->setIdentifier($this->id);
    }

    /**
     * Retrieve the basket contents.
     *
     * @param bool $asArray
     *
     * @return array An array of Item objects
     */
    public function &contents($asArray = false)
    {
        return $this->store->data($asArray);
    }

    /**
     * Insert an item into the basket.
     *
     * @param array $item An array of item data
     *
     * @return string A unique item identifier
     */
    public function insert(array $item)
    {
        $this->checkArgs($item);

        $itemIdentifier = $this->createItemIdentifier($item);

        if ($this->has($itemIdentifier)) {
            $item['quantity'] = $this->item($itemIdentifier)->quantity + $item['quantity'];
<?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.");
        }
    }

}
            $this->update($itemIdentifier, $item);

            return $itemIdentifier;
        }

        $item = new Item($itemIdentifier, $item, $this->store);

        $this->store->insertUpdate($item);

        return $itemIdentifier;
    }

    /**
     * Update an item.
     *
     * @param string           $itemIdentifier The unique item identifier
     * @param string|int|array $key            The key to update, or an array of key-value pairs
     * @param mixed            $value          The value to set $key to
     *
     * @return void
     */
    public function update($itemIdentifier, $key, $value = null)
    {
        foreach ($this->contents() as $item) {
            if ($item->identifier == $itemIdentifier) {
                $item->update($key, $value);
                break;
            }
        }
    }

    /**
     * Remove an item from the basket.
     *
     * @param string $identifier Unique item identifier
     *
     * @return void
     */
    public function remove($identifier)
    {
        $this->store->remove($identifier);
    }

    /**
     * Destroy/empty the basket.
     *
     * @return void
     */
    public function destroy()
    {
        $this->store->destroy();
    }

    /**
     * Check if the basket has a specific item.
     *
     * @param string $itemIdentifier The unique item identifier
     *
     * @return bool Yes or no?
     */
    public function has($itemIdentifier)
    {
        return $this->store->has($itemIdentifier);
    }

    /**
     * Return a specific item object by identifier.
     *
     * @param string $itemIdentifier The unique item identifier
     *
     * @return Item Item object
     */
    public function item($itemIdentifier)
    {
        return $this->store->item($itemIdentifier);
    }

    /**
     * Returns the first occurance of an item with a given id.
     *
     * @param string $id The item id
     *
     * @return Item Item object
     */
    public function find($id)
    {
        return $this->store->find($id);
    }

    /**
     * The total tax value for the basket.
     *
     * @return float The total tax value
     */
    public function tax()
    {
        $total = 0;

        foreach ($this->contents() as $item) {
            $total += (float) $item->tax();
        }

        return $total;
    }

    /**
     * The total weight value for the basket.
     *
     * @return float The total weight value
     */
    public function weight()
    {
        $weight = 0;

        foreach ($this->contents() as $item) {
            $weight += (float) $item->weight();
        }

        return $weight;
    }

    /**
     * The total value of the basket.
     *
     * @param bool $includeTax Include tax on the total?
     *
     * @return float The total basket value
     */
    public function total($includeTax = true)
    {
        $total = 0;

        foreach ($this->contents() as $item) {
            $total += (float) $item->total($includeTax);
        }

        return (float) $total;
    }

    /**
     * The total number of items in the basket.
     *
     * @param bool $unique Just return unique items?
     *
     * @return int Total number of items
     */
    public function totalItems($unique = false)
    {
        $total = 0;

        foreach ($this->contents() as $item) {
            $total += $unique ? 1 : $item->quantity;
        }

        return $total;
    }

    /**
     * Set the basket identifier, useful if restoring a saved basket.
     *
     * @param  mixed The identifier
     *
     * @return void
     */
    public function setIdentifier($identifier)
    {
        $this->store->setIdentifier($identifier);
    }

    /**
     * Create a unique item identifier.
     *
     * @param array $item An array of item data
     *
     * @return string An md5 hash of item
     */
    protected function createItemIdentifier(array $item)
    {
        if (!array_key_exists('options', $item)) {
            $item['options'] = [];
        }

        ksort($item['options']);

        return md5($item['id'].serialize($item['options']));
    }

    /**
     * Check if a basket item has the required parameters.
     *
     * @param array $item An array of item data
     *
     * @return void
     */
    protected function checkArgs(array $item)
    {
        foreach ($this->requiredParams as $param) {
            if (!array_key_exists($param, $item)) {
                throw new InvalidArgumentException("The '{$param}' field is required");
            }
        }
    }
}


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) 2013 Lenius.
8		* http://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 2013 Lenius.
15		*
16		* @version dev
17		*
18		* @link http://github.com/lenius/basket
19		*/
20		namespace Lenius\Basket;
21
22		use InvalidArgumentException;
23
24		class Basket
25		{
26		protected $id;
27
28		protected $identifier;
29		protected $store;
30
31		protected $currency;
32
33		protected $requiredParams = [
34		'id',
35		'name',
36		'quantity',
37		'price',
38		'weight',
39		];
40
41		/**
42		* Basket constructor.
43		*
44		* @param StorageInterface $store The interface for storing the cart data
45		* @param IdentifierInterface $identifier The interface for storing the identifier
46		*/
47	14	public function __construct(StorageInterface $store, IdentifierInterface $identifier)
48	1	{
49	14	$this->store = $store;
50	14	$this->identifier = $identifier;
51
52		// Generate/retrieve identifier
53	14	$this->id = $this->identifier->get();
54
55		// Restore the cart from a saved version
56	14	if (method_exists($this->store, 'restore')) {
57		$this->store->restore();
		0 ignored issues – show Bug introduced 2016-07-21 20:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Lenius\Basket\StorageInterface` as the method `restore()` does only exist in the following implementations of said interface: `Lenius\Basket\Storage\Session`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
58		}
59
60		// Let our storage class know which cart we're talking about
61	14	$this->store->setIdentifier($this->id);
62	14	}
63
64		/**
65		* Retrieve the basket contents.
66		*
67		* @param bool $asArray
68		*
69		* @return array An array of Item objects
70		*/
71	9	public function &contents($asArray = false)
72		{
73	9	return $this->store->data($asArray);
74		}
75
76		/**
77		* Insert an item into the basket.
78		*
79		* @param array $item An array of item data
80		*
81		* @return string A unique item identifier
82		*/
83	14	public function insert(array $item)
84		{
85	14	$this->checkArgs($item);
86
87	14	$itemIdentifier = $this->createItemIdentifier($item);
88
89	14	if ($this->has($itemIdentifier)) {
90	1	$item['quantity'] = $this->item($itemIdentifier)->quantity + $item['quantity'];
		0 ignored issues – show Documentation introduced 2016-07-21 20:49 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<Lenius\Basket\Item>`. 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...
91	6	$this->update($itemIdentifier, $item);
92
93	1	return $itemIdentifier;
94		}
95
96	14	$item = new Item($itemIdentifier, $item, $this->store);
97
98	14	$this->store->insertUpdate($item);
99
100	14	return $itemIdentifier;
101		}
102
103		/**
104		* Update an item.
105		*
106		* @param string $itemIdentifier The unique item identifier
107		* @param string\|int\|array $key The key to update, or an array of key-value pairs
108		* @param mixed $value The value to set $key to
109		*
110		* @return void
111		*/
112	2	public function update($itemIdentifier, $key, $value = null)
113		{
114	2	foreach ($this->contents() as $item) {
115	2	if ($item->identifier == $itemIdentifier) {
116	2	$item->update($key, $value);
117	2	break;
118		}
119	2	}
120	2	}
121
122		/**
123		* Remove an item from the basket.
124		*
125		* @param string $identifier Unique item identifier
126		*
127		* @return void
128		*/
129	1	public function remove($identifier)
130		{
131	1	$this->store->remove($identifier);
132	1	}
133
134		/**
135		* Destroy/empty the basket.
136		*
137		* @return void
138		*/
139	14	public function destroy()
140		{
141	14	$this->store->destroy();
142	14	}
143
144		/**
145		* Check if the basket has a specific item.
146		*
147		* @param string $itemIdentifier The unique item identifier
148		*
149		* @return bool Yes or no?
150		*/
151	14	public function has($itemIdentifier)
152		{
153	14	return $this->store->has($itemIdentifier);
154		}
155
156		/**
157		* Return a specific item object by identifier.
158		*
159		* @param string $itemIdentifier The unique item identifier
160		*
161		* @return Item Item object
162		*/
163	6	public function item($itemIdentifier)
164		{
165	6	return $this->store->item($itemIdentifier);
166		}
167
168		/**
169		* Returns the first occurance of an item with a given id.
170		*
171		* @param string $id The item id
172		*
173		* @return Item Item object
174		*/
175	1	public function find($id)
176		{
177	1	return $this->store->find($id);
178		}
179
180		/**
181		* The total tax value for the basket.
182		*
183		* @return float The total tax value
184		*/
185		public function tax()
186		{
187		$total = 0;
188
189		foreach ($this->contents() as $item) {
190		$total += (float) $item->tax();
191		}
192
193		return $total;
194		}
195
196		/**
197		* The total weight value for the basket.
198		*
199		* @return float The total weight value
200		*/
201		public function weight()
202		{
203		$weight = 0;
204
205		foreach ($this->contents() as $item) {
206		$weight += (float) $item->weight();
207		}
208
209		return $weight;
210		}
211
212		/**
213		* The total value of the basket.
214		*
215		* @param bool $includeTax Include tax on the total?
216		*
217		* @return float The total basket value
218		*/
219	3	public function total($includeTax = true)
220		{
221	3	$total = 0;
222
223	3	foreach ($this->contents() as $item) {
224	3	$total += (float) $item->total($includeTax);
225	3	}
226
227	3	return (float) $total;
228		}
229
230		/**
231		* The total number of items in the basket.
232		*
233		* @param bool $unique Just return unique items?
234		*
235		* @return int Total number of items
236		*/
237	1	public function totalItems($unique = false)
238		{
239	1	$total = 0;
240
241	1	foreach ($this->contents() as $item) {
242	1	$total += $unique ? 1 : $item->quantity;
243	1	}
244
245	1	return $total;
246		}
247
248		/**
249		* Set the basket identifier, useful if restoring a saved basket.
250		*
251		* @param mixed The identifier
252		*
253		* @return void
254		*/
255		public function setIdentifier($identifier)
256		{
257		$this->store->setIdentifier($identifier);
258		}
259
260		/**
261		* Create a unique item identifier.
262		*
263		* @param array $item An array of item data
264		*
265		* @return string An md5 hash of item
266		*/
267	14	protected function createItemIdentifier(array $item)
268		{
269	14	if (!array_key_exists('options', $item)) {
270	13	$item['options'] = [];
271	13	}
272
273	14	ksort($item['options']);
274
275	14	return md5($item['id'].serialize($item['options']));
276		}
277
278		/**
279		* Check if a basket item has the required parameters.
280		*
281		* @param array $item An array of item data
282		*
283		* @return void
284		*/
285	14	protected function checkArgs(array $item)
286		{
287	14	foreach ($this->requiredParams as $param) {
288	14	if (!array_key_exists($param, $item)) {
289		throw new InvalidArgumentException("The '{$param}' field is required");
290		}
291	14	}
292	14	}
293		}
294

Lenius / basket

Push — master ( 9a3c41...108cc9 )

Basket::contents() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like