CollectionTrait::getItemName() - Code Metrics - Inspection of "get item name for collections" - robotE13/ddd-common - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( da3c73...a3b48d )

by Evgenii

created 2021-07-12 17:03 UTC

CollectionTrait::getItemName() A

↳ Parent: CollectionTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the ddd-common.
 *
 * Copyright 2021 Evgenii Dudal <[email protected]>.
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 * @package ddd-common
 */

namespace RobotE13\DDD\Entities\Collection;

use Webmozart\Assert\Assert;

/**
 *
 * @author Evgenii Dudal <[email protected]>
 */
trait CollectionTrait
{

    protected static $collectionItemName = 'Item';
    private $items = [];

    public function exist($index): bool
    {
        return key_exists($index, $this->items);
    }

    /**
     *
     * @param mixed $key
     * @return mixed
     * @throws \InvalidArgumentException
     */
    public function get($key)
    {
        Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection");
        return clone $this->items[$key];
    }

    public function remove($key): void
    {
        Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection.");
        unset($this->items[$key]);
    }

    public function toArray()
    {
        return $this->items;
    }

    public function count(): int
    {
        return count($this->items);
    }

    public function getIterator(): \Traversable
    {
        yield from $this->items;
    }

    public static function getItemName(): string
    {
        return 'Item';
    }

}


1		<?php
2
3		/*
4		* This file is part of the ddd-common.
5		*
6		* Copyright 2021 Evgenii Dudal <[email protected]>.
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		* @package ddd-common
11		*/
12
13		namespace RobotE13\DDD\Entities\Collection;
14
15		use Webmozart\Assert\Assert;
16
17		/**
18		*
19		* @author Evgenii Dudal <[email protected]>
20		*/
21		trait CollectionTrait
22		{
23
24		protected static $collectionItemName = 'Item';
25		private $items = [];
26
27		public function exist($index): bool
28		{
29		return key_exists($index, $this->items);
30		}
31
32		/**
33		*
34		* @param mixed $key
35		* @return mixed
36		* @throws \InvalidArgumentException
37		*/
38		public function get($key)
39		{
40		Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection");
41		return clone $this->items[$key];
42		}
43
44	2	public function remove($key): void
45		{
46	2	Assert::keyExists($this->items, $key, static::getItemName() . " with key `{$key}` not present in collection.");
47		unset($this->items[$key]);
48		}
49
50	2	public function toArray()
51		{
52	2	return $this->items;
53		}
54
55	2	public function count(): int
56		{
57	2	return count($this->items);
58		}
59
60	2	public function getIterator(): \Traversable
61		{
62	2	yield from $this->items;
63	2	}
64
65		public static function getItemName(): string
66		{
67		return 'Item';
68		}
69
70		}
71

robotE13 / ddd-common

Push — master ( da3c73...a3b48d )

CollectionTrait::getItemName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like