AbstractCollection::contains() - Code Metrics - Inspection of "Fixing implementation of ArraySet" - tebru/php-collections - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 067505...e5d322 )

by Nate

created 2017-01-16 02:01 UTC

AbstractCollection::contains() A

↳ Parent: AbstractCollection

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

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

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

namespace Tebru\Collection;

/**
 * Class AbstractCollection
 *
 * Provides a skeletal implementation of the [@see CollectionInterface]
 *
 * @author Nate Brunette <[email protected]>
 */
abstract class AbstractCollection implements CollectionInterface
{
    /**
     * Ensure all elements of a collection exists in this collection
     *
     * Return true if the collection has changed, and false if it hasn't
     *
     * @param CollectionInterface $collection
     * @return bool
     */
    public function addAll(CollectionInterface $collection): bool
    {
        return $this->addAllArray($collection->toArray());
    }

    /**
     * Ensure all elements of an array exists in this collection
     *
     * Return true if the collection has changed, and false if it hasn't
     *
     * @param array $collection
     * @return bool
     */
    public function addAllArray(array $collection): bool
    {
        $size = $this->count();
        foreach ($collection as $element) {
            $this->add($element);
        }

        return $size !== $this->count();
    }

    /**
     * Returns true if the collection contains all elements from another collection
     *
     * @param CollectionInterface $collection
     * @return bool
     */
    public function containsAll(CollectionInterface $collection): bool
    {
        return $this->containsAllArray($collection->toArray());
    }

    /**
     * Returns true if the collection contains all elements from an array
     *
     * @param array $collection
     * @return bool
     */
    public function containsAllArray(array $collection): bool
    {
        foreach ($collection as $element) {
            if (!$this->contains($element)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Returns the size of the collection
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->toArray());
    }

    /**
     * Returns true if the collection is empty
     *
     * @return bool
     */
    public function isEmpty(): bool
    {
        return 0 === $this->count();
    }

    /**
     * Remove all items in a collection from this collection
     *
     * Returns true if the collection was modified
     *
     * @param CollectionInterface $collection
     * @return bool
     */
    public function removeAll(CollectionInterface $collection): bool
    {
        return $this->removeAllArray($collection->toArray());
    }

    /**
     * Remove all items in an array from this collection
     *
     * Returns true if the collection was modified
     *
     * @param array $collection
     * @return bool
     */
    public function removeAllArray(array $collection): bool
    {
        $size = $this->count();
        foreach ($collection as $element) {
            $this->remove($element);
        }

        return $size !== $this->count();
    }

    /**
     * Remove all items from this collection that don't exist in specified collection
     *
     * Returns true if the collection was modified
     *
     * @param CollectionInterface $collection
     * @return bool
     */
    public function retainAll(CollectionInterface $collection): bool
    {
        return $this->retainAllArray($collection->toArray());
    }

    /**
     * Remove all items from this collection that don't exist in specified array
     *
     * Returns true if the collection was modified
     *
     * @param array $collection
     * @return bool
     */
    public function retainAllArray(array $collection): bool
    {
        $size = $this->count();
        foreach ($this as $element) {
            if (!in_array($element, $collection, true)) {
                $this->remove($element);
            }
        }

        return $size !== $this->count();
    }

    /**
     * Find the first element in collection
     *
     * The closure will get passed each element.  Returning true will end the
     * loop and return that element
     *
     * @param callable $find
     * @return mixed
     */
    public function find(callable $find)
    {
        foreach ($this as $element) {
            if (true === $find($element)) {
                return $element;
            }
        }

        return null;
    }

    /**
     * Use a closure to determine existence in the collection
     *
     * The closure will get passed each element.  Returning true from the
     * closure will return true from this method.
     *
     * @param callable $exists
     * @return bool
     */
    public function exists(callable $exists): bool
    {
        foreach ($this as $element) {
            if (true === $exists($element)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Filter the collection using closure
     *
     * The closure will get passed each element.  Returning true from the
     * closure will include that element in the new collection.
     *
     * @param callable $filter
     * @return CollectionInterface
     */
    public function filter(callable $filter): CollectionInterface
    {
        return new static(array_filter($this->toArray(), $filter));

    }
}


1		<?php
2		/*
3		* Copyright (c) Nate Brunette.
4		* Distributed under the MIT License (http://opensource.org/licenses/MIT)
5		*/
6
7		namespace Tebru\Collection;
8
9		/**
10		* Class AbstractCollection
11		*
12		* Provides a skeletal implementation of the [@see CollectionInterface]
13		*
14		* @author Nate Brunette <[email protected]>
15		*/
16		abstract class AbstractCollection implements CollectionInterface
17		{
18		/**
19		* Ensure all elements of a collection exists in this collection
20		*
21		* Return true if the collection has changed, and false if it hasn't
22		*
23		* @param CollectionInterface $collection
24		* @return bool
25		*/
26	5	public function addAll(CollectionInterface $collection): bool
27		{
28	5	return $this->addAllArray($collection->toArray());
29		}
30
31		/**
32		* Ensure all elements of an array exists in this collection
33		*
34		* Return true if the collection has changed, and false if it hasn't
35		*
36		* @param array $collection
37		* @return bool
38		*/
39	105	public function addAllArray(array $collection): bool
40		{
41	105	$size = $this->count();
42	105	foreach ($collection as $element) {
43	105	$this->add($element);
44		}
45
46	105	return $size !== $this->count();
47		}
48
49		/**
50		* Returns true if the collection contains all elements from another collection
51		*
52		* @param CollectionInterface $collection
53		* @return bool
54		*/
55	15	public function containsAll(CollectionInterface $collection): bool
56		{
57	15	return $this->containsAllArray($collection->toArray());
58		}
59
60		/**
61		* Returns true if the collection contains all elements from an array
62		*
63		* @param array $collection
64		* @return bool
65		*/
66	20	public function containsAllArray(array $collection): bool
67		{
68	20	foreach ($collection as $element) {
69	20	if (!$this->contains($element)) {
70	20	return false;
71		}
72		}
73
74	15	return true;
75		}
76
77		/**
78		* Returns the size of the collection
79		*
80		* @return int
81		*/
82	125	public function count(): int
83		{
84	125	return count($this->toArray());
85		}
86
87		/**
88		* Returns true if the collection is empty
89		*
90		* @return bool
91		*/
92	10	public function isEmpty(): bool
93		{
94	10	return 0 === $this->count();
95		}
96
97		/**
98		* Remove all items in a collection from this collection
99		*
100		* Returns true if the collection was modified
101		*
102		* @param CollectionInterface $collection
103		* @return bool
104		*/
105	15	public function removeAll(CollectionInterface $collection): bool
106		{
107	15	return $this->removeAllArray($collection->toArray());
108		}
109
110		/**
111		* Remove all items in an array from this collection
112		*
113		* Returns true if the collection was modified
114		*
115		* @param array $collection
116		* @return bool
117		*/
118	20	public function removeAllArray(array $collection): bool
119		{
120	20	$size = $this->count();
121	20	foreach ($collection as $element) {
122	20	$this->remove($element);
123		}
124
125	20	return $size !== $this->count();
126		}
127
128		/**
129		* Remove all items from this collection that don't exist in specified collection
130		*
131		* Returns true if the collection was modified
132		*
133		* @param CollectionInterface $collection
134		* @return bool
135		*/
136	15	public function retainAll(CollectionInterface $collection): bool
137		{
138	15	return $this->retainAllArray($collection->toArray());
139		}
140
141		/**
142		* Remove all items from this collection that don't exist in specified array
143		*
144		* Returns true if the collection was modified
145		*
146		* @param array $collection
147		* @return bool
148		*/
149	12	public function retainAllArray(array $collection): bool
150		{
151	12	$size = $this->count();
152	12	foreach ($this as $element) {
153	12	if (!in_array($element, $collection, true)) {
154	12	$this->remove($element);
155		}
156		}
157
158	12	return $size !== $this->count();
159		}
160
161		/**
162		* Find the first element in collection
163		*
164		* The closure will get passed each element. Returning true will end the
165		* loop and return that element
166		*
167		* @param callable $find
168		* @return mixed
169		*/
170	10	public function find(callable $find)
171		{
172	10	foreach ($this as $element) {
173	10	if (true === $find($element)) {
174	10	return $element;
175		}
176		}
177
178	5	return null;
179		}
180
181		/**
182		* Use a closure to determine existence in the collection
183		*
184		* The closure will get passed each element. Returning true from the
185		* closure will return true from this method.
186		*
187		* @param callable $exists
188		* @return bool
189		*/
190	5	public function exists(callable $exists): bool
191		{
192	5	foreach ($this as $element) {
193	5	if (true === $exists($element)) {
194	5	return true;
195		}
196		}
197
198	5	return false;
199		}
200
201		/**
202		* Filter the collection using closure
203		*
204		* The closure will get passed each element. Returning true from the
205		* closure will include that element in the new collection.
206		*
207		* @param callable $filter
208		* @return CollectionInterface
209		*/
210	5	public function filter(callable $filter): CollectionInterface
211		{
212	5	return new static(array_filter($this->toArray(), $filter));
		0 ignored issues – show Unused Code introduced 2016-10-14 23:56 UTC by Report Bug Copy Issue Report The call to `AbstractCollection::__construct()` has too many arguments starting with `array_filter($this->toArray(), $filter)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
213		}
214		}
215

tebru / php-collections

Push — master ( 067505...e5d322 )

AbstractCollection::contains() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like