EntitySet::offsetSet() - Code Metrics - Inspection of "Refactor the whole WebHemi/Data namespace in order..." - Gixx/WebHemi - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — lab/data (a414ec)

by Gabor

created 2018-02-16 15:17 UTC

EntitySet::offsetSet() B

↳ Parent: EntitySet

Complexity

Conditions	6
Paths	12

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.5125
c	0
b	0
f	0
cc	6
eloc	13
nc	12
nop	2

<?php
/**
 * WebHemi.
 *
 * PHP version 7.1
 *
 * @copyright 2012 - 2018 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link http://www.gixx-web.com
 */
declare(strict_types = 1);

namespace WebHemi\Data\Entity;

use ArrayAccess;
use InvalidArgumentException;
use Iterator;

/**
 * Class EntitySet.
 *
 * We have some strictness additions to the original ArrayAccess and Iterator interfaces.
 * A) The offset must be Integer.
 * B) The value must be an object that implements the EntityInterface.
 */
class EntitySet implements ArrayAccess, Iterator
{
    /**
     * @var array
     */
    private $container = [];

    /**
     * Checks whether an offset exists.
     *
     * @param int $offset
     * @throws InvalidArgumentException
     * @return bool
     */
    public function offsetExists($offset) : bool

    {
        if (!is_int($offset)) {
            throw new InvalidArgumentException(
                sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
                1000
            );
        }

        return isset($this->container[$offset]);
    }

    /**
     * Returns the value at an offset.
     *
     * @param int $offset
     * @throws InvalidArgumentException
     * @return null|EntityInterface
     */
    public function offsetGet($offset)

    {
        if (!is_int($offset)) {
            throw new InvalidArgumentException(
                sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
                1001
            );
        }

        return $this->container[$offset] ?? null;
    }

    /**
     * Sets a value for an offset. It appends it if offset is Null.
     *
     * @param null|int $offset
     * @param EntityInterface $value
     * @throws InvalidArgumentException
     */
    public function offsetSet($offset, $value) : void
    {
        if (is_null($offset)) {
            $offset = empty($this->container) ? 0 : max(array_keys($this->container)) + 1;
        }

        if (!is_int($offset)) {
            throw new InvalidArgumentException(
                sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
                1002
            );
        }

        if (!$value instanceof EntityInterface) {
            $valueType = is_object($value) ? get_class($value) : gettype($value);

            throw new InvalidArgumentException(
                sprintf(__METHOD__.' requires parameter 2 to be an instance of EntityInterface, %s given.', $valueType),
                1003
            );
        }

        $this->container[$offset] = $value;
    }

    /**
     * Deletes a record from the container at an offset. It will not reorder the container.
     *
     * @param mixed $offset
     * @throws InvalidArgumentException
     */
    public function offsetUnset($offset) : void

    {
        if (!is_int($offset)) {
            throw new InvalidArgumentException(
                sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
                1004
            );
        }

        if ($this->offsetExists($offset)) {
            unset($this->container[$offset]);
        }
    }

    /**
     * Rewinds the Iterator to the first element.
     */
    public function rewind() : void
    {
        reset($this->container);
    }

    /**
     * Returns the current element.
     *
     * @return mixed
     */
    public function current()
    {
        return current($this->container);
    }

    /**
     * Returns the key of the current element.
     *
     * @return int|mixed|null|string
     */
    public function key()
    {
        return key($this->container);
    }

    /**
     * Moves forward to next element.
     */
    public function next() : void
    {
        next($this->container);
    }

    /**
     * Checks if current position is valid.
     *
     * @return bool
     */
    public function valid() : bool
    {
        return key($this->container) !== null;
    }

    /**
     * Return the raw container
     *
     * @return array
     */
    public function toArray() : array
    {
        return $this->container;
    }

    /**
     * Merges another EntitySet into the current container.
     *
     * @param EntitySet $entitySet
     */
    public function merge(EntitySet $entitySet) : void
    {
        $this->container = array_merge($this->container, $entitySet->toArray());
    }
}


1		<?php
2		/**
3		* WebHemi.
4		*
5		* PHP version 7.1
6		*
7		* @copyright 2012 - 2018 Gixx-web (http://www.gixx-web.com)
8		* @license https://opensource.org/licenses/MIT The MIT License (MIT)
9		*
10		* @link http://www.gixx-web.com
11		*/
12		declare(strict_types = 1);
13
14		namespace WebHemi\Data\Entity;
15
16		use ArrayAccess;
17		use InvalidArgumentException;
18		use Iterator;
19
20		/**
21		* Class EntitySet.
22		*
23		* We have some strictness additions to the original ArrayAccess and Iterator interfaces.
24		* A) The offset must be Integer.
25		* B) The value must be an object that implements the EntityInterface.
26		*/
27		class EntitySet implements ArrayAccess, Iterator
28		{
29		/**
30		* @var array
31		*/
32		private $container = [];
33
34		/**
35		* Checks whether an offset exists.
36		*
37		* @param int $offset
38		* @throws InvalidArgumentException
39		* @return bool
40		*/
41	View Code Duplication	public function offsetExists($offset) : bool
		0 ignored issues – show Duplication introduced 2018-02-16 15:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
42		{
43		if (!is_int($offset)) {
44		throw new InvalidArgumentException(
45		sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
46		1000
47		);
48		}
49
50		return isset($this->container[$offset]);
51		}
52
53		/**
54		* Returns the value at an offset.
55		*
56		* @param int $offset
57		* @throws InvalidArgumentException
58		* @return null\|EntityInterface
59		*/
60	View Code Duplication	public function offsetGet($offset)
		0 ignored issues – show Duplication introduced 2018-02-16 15:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		{
62		if (!is_int($offset)) {
63		throw new InvalidArgumentException(
64		sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
65		1001
66		);
67		}
68
69		return $this->container[$offset] ?? null;
70		}
71
72		/**
73		* Sets a value for an offset. It appends it if offset is Null.
74		*
75		* @param null\|int $offset
76		* @param EntityInterface $value
77		* @throws InvalidArgumentException
78		*/
79		public function offsetSet($offset, $value) : void
80		{
81		if (is_null($offset)) {
82		$offset = empty($this->container) ? 0 : max(array_keys($this->container)) + 1;
83		}
84
85		if (!is_int($offset)) {
86		throw new InvalidArgumentException(
87		sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
88		1002
89		);
90		}
91
92		if (!$value instanceof EntityInterface) {
93		$valueType = is_object($value) ? get_class($value) : gettype($value);
94
95		throw new InvalidArgumentException(
96		sprintf(__METHOD__.' requires parameter 2 to be an instance of EntityInterface, %s given.', $valueType),
97		1003
98		);
99		}
100
101		$this->container[$offset] = $value;
102		}
103
104		/**
105		* Deletes a record from the container at an offset. It will not reorder the container.
106		*
107		* @param mixed $offset
108		* @throws InvalidArgumentException
109		*/
110	View Code Duplication	public function offsetUnset($offset) : void
		0 ignored issues – show Duplication introduced 2018-02-16 15:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
111		{
112		if (!is_int($offset)) {
113		throw new InvalidArgumentException(
114		sprintf(__METHOD__.' requires parameter 1 to be integer, %s given.', gettype($offset)),
115		1004
116		);
117		}
118
119		if ($this->offsetExists($offset)) {
120		unset($this->container[$offset]);
121		}
122		}
123
124		/**
125		* Rewinds the Iterator to the first element.
126		*/
127		public function rewind() : void
128		{
129		reset($this->container);
130		}
131
132		/**
133		* Returns the current element.
134		*
135		* @return mixed
136		*/
137		public function current()
138		{
139		return current($this->container);
140		}
141
142		/**
143		* Returns the key of the current element.
144		*
145		* @return int\|mixed\|null\|string
146		*/
147		public function key()
148		{
149		return key($this->container);
150		}
151
152		/**
153		* Moves forward to next element.
154		*/
155		public function next() : void
156		{
157		next($this->container);
158		}
159
160		/**
161		* Checks if current position is valid.
162		*
163		* @return bool
164		*/
165		public function valid() : bool
166		{
167		return key($this->container) !== null;
168		}
169
170		/**
171		* Return the raw container
172		*
173		* @return array
174		*/
175		public function toArray() : array
176		{
177		return $this->container;
178		}
179
180		/**
181		* Merges another EntitySet into the current container.
182		*
183		* @param EntitySet $entitySet
184		*/
185		public function merge(EntitySet $entitySet) : void
186		{
187		$this->container = array_merge($this->container, $entitySet->toArray());
188		}
189		}
190

Gixx / WebHemi

Branch — lab/data (a414ec)

EntitySet::offsetSet() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like