AbstractCollection::rewind() - Code Metrics - Inspection of "fixed signatures for classes" - FusionPHP/collection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3e146f...5e7d15 )

by Jason

created 2018-05-25 16:19 UTC

AbstractCollection::rewind() A

↳ Parent: AbstractCollection

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
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0
crap	1

<?php

/**
 * Part of the Fusion.Collection package.
 *
 * @license MIT
 */

declare(strict_types=1);

namespace Fusion\Collection\Contracts;

use ArrayAccess;
use Iterator;

/**
 * Implements core functionality for collections.
 *
 * @since 1.0.0
 */
abstract class AbstractCollection implements CollectionCoreInterface, ArrayAccess, Iterator
{
    /** @var array */
    protected $collection = [];

    /** @var \Fusion\Collection\Contracts\CollectionValidationInterface */
    protected $validator;

    /** {@inheritdoc} */
    public function clear(): void
    {
        $this->collection = [];
    }

    /** {@inheritdoc} */
    public function remove($item): void
    {
        foreach ($this->collection as $key => $value)
        {
            if ($item === $value)
            {
                $this->removeAt($key);
            }
        }
    }

    /** {@inheritdoc} */
    public function removeAt($key): void
    {
        if ($this->offsetExists($key))
        {
            if (is_int($key))
            {
                array_splice($this->collection, $key, 1);
            }
            else
            {
                if (is_string($key))
                {
                    unset($this->collection[$key]);
                }
            }
        }
    }

    /**
     * Checks if an offset exists in the collection.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
     *
     * @param mixed $offset
     *
     * @return bool
     */
    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->collection);
    }

    /**
     * Retrieves a value at the given offset.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetget.php
     *
     * @param mixed $offset
     *
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return $this->collection[$offset];
    }

    /**
     * Sets a value at the given offset.
     *
     * This method will throw a `CollectionException` if the offset does not exist.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param mixed $offset
     * @param mixed $value
     *
     * @return void
     *
     * @throws \Fusion\Collection\Exceptions\CollectionException
     */
    public function offsetSet($offset, $value): void
    {
        $this->validator->validateNonNullValue($value);
        $this->collection[$offset] = $value;
    }

    /**
     * Removes a value at the given offset.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
     *
     * @param mixed $offset
     *
     * @return void
     */
    public function offsetUnset($offset): void
    {
        if ($this->offsetExists($offset))
        {
            $this->removeAt($offset);
        }
    }

    /**
     * Returns the current element in the collection.
     *
     * @link http://php.net/manual/en/iterator.current.php
     *
     * @return mixed
     */
    public function current()
    {
        return current($this->collection);
    }

    /**
     * Move forward to the next element in the collection.
     *
     * @link http://php.net/manual/en/iterator.next.php
     *
     * @return void
     */
    public function next(): void
    {
        next($this->collection);
    }

    /**
     * Return the key of the current element in the collection.
     *
     * @link http://php.net/manual/en/iterator.key.php
     *
     * @return mixed
     */
    public function key()
    {
        return key($this->collection);
    }

    /**
     * Checks if the current element position is valid.
     *
     * @link http://php.net/manual/en/iterator.valid.php
     *
     * @return bool
     */
    public function valid(): bool
    {
        return key($this->collection) !== null;
    }

    /**
     * Rewind the collection's position to the first index.
     *
     * @link http://php.net/manual/en/iterator.rewind.php
     *
     * @return void
     */
    public function rewind(): void
    {
        reset($this->collection);
    }

    /**
     * Returns of count of the elements in a collection.
     *
     * @link http://php.net/manual/en/countable.count.php
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->collection);
    }
}

1		<?php
2
3		/**
4		* Part of the Fusion.Collection package.
5		*
6		* @license MIT
7		*/
8
9		declare(strict_types=1);
10
11		namespace Fusion\Collection\Contracts;
12
13		use ArrayAccess;
14		use Iterator;
15
16		/**
17		* Implements core functionality for collections.
18		*
19		* @since 1.0.0
20		*/
21		abstract class AbstractCollection implements CollectionCoreInterface, ArrayAccess, Iterator
22		{
23		/** @var array */
24		protected $collection = [];
25
26		/** @var \Fusion\Collection\Contracts\CollectionValidationInterface */
27		protected $validator;
28
29		/** {@inheritdoc} */
30	1	public function clear(): void
31		{
32	1	$this->collection = [];
33	1	}
34
35		/** {@inheritdoc} */
36	3	public function remove($item): void
37		{
38	3	foreach ($this->collection as $key => $value)
39		{
40	3	if ($item === $value)
41		{
42	3	$this->removeAt($key);
43		}
44		}
45	3	}
46
47		/** {@inheritdoc} */
48	6	public function removeAt($key): void
49		{
50	6	if ($this->offsetExists($key))
51		{
52	6	if (is_int($key))
53		{
54	3	array_splice($this->collection, $key, 1);
55		}
56		else
57		{
58	3	if (is_string($key))
59		{
60	3	unset($this->collection[$key]);
61		}
62		}
63		}
64	6	}
65
66		/**
67		* Checks if an offset exists in the collection.
68		*
69		* @link http://php.net/manual/en/arrayaccess.offsetexists.php
70		*
71		* @param mixed $offset
72		*
73		* @return bool
74		*/
75	38	public function offsetExists($offset)
76		{
77	38	return array_key_exists($offset, $this->collection);
78		}
79
80		/**
81		* Retrieves a value at the given offset.
82		*
83		* @link http://php.net/manual/en/arrayaccess.offsetget.php
84		*
85		* @param mixed $offset
86		*
87		* @return mixed
88		*/
89	16	public function offsetGet($offset)
90		{
91	16	return $this->collection[$offset];
92		}
93
94		/**
95		* Sets a value at the given offset.
96		*
97		* This method will throw a `CollectionException` if the offset does not exist.
98		*
99		* @link http://php.net/manual/en/arrayaccess.offsetset.php
100		*
101		* @param mixed $offset
102		* @param mixed $value
103		*
104		* @return void
105		*
106		* @throws \Fusion\Collection\Exceptions\CollectionException
107		*/
108	28	public function offsetSet($offset, $value): void
109		{
110	28	$this->validator->validateNonNullValue($value);
111	25	$this->collection[$offset] = $value;
112	25	}
113
114		/**
115		* Removes a value at the given offset.
116		*
117		* @link http://php.net/manual/en/arrayaccess.offsetunset.php
118		*
119		* @param mixed $offset
120		*
121		* @return void
122		*/
123	3	public function offsetUnset($offset): void
124		{
125	3	if ($this->offsetExists($offset))
126		{
127	3	$this->removeAt($offset);
128		}
129	3	}
130
131		/**
132		* Returns the current element in the collection.
133		*
134		* @link http://php.net/manual/en/iterator.current.php
135		*
136		* @return mixed
137		*/
138	4	public function current()
139		{
140	4	return current($this->collection);
141		}
142
143		/**
144		* Move forward to the next element in the collection.
145		*
146		* @link http://php.net/manual/en/iterator.next.php
147		*
148		* @return void
149		*/
150	4	public function next(): void
151		{
152	4	next($this->collection);
153	4	}
154
155		/**
156		* Return the key of the current element in the collection.
157		*
158		* @link http://php.net/manual/en/iterator.key.php
159		*
160		* @return mixed
161		*/
162	2	public function key()
163		{
164	2	return key($this->collection);
165		}
166
167		/**
168		* Checks if the current element position is valid.
169		*
170		* @link http://php.net/manual/en/iterator.valid.php
171		*
172		* @return bool
173		*/
174	3	public function valid(): bool
175		{
176	3	return key($this->collection) !== null;
177		}
178
179		/**
180		* Rewind the collection's position to the first index.
181		*
182		* @link http://php.net/manual/en/iterator.rewind.php
183		*
184		* @return void
185		*/
186	2	public function rewind(): void
187		{
188	2	reset($this->collection);
189	2	}
190
191		/**
192		* Returns of count of the elements in a collection.
193		*
194		* @link http://php.net/manual/en/countable.count.php
195		*
196		* @return int
197		*/
198	28	public function count(): int
199		{
200	28	return count($this->collection);
201		}
202		}

FusionPHP / collection

Push — master ( 3e146f...5e7d15 )

AbstractCollection::rewind() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like