Set::clear() - Code Metrics - Inspection of "*Updated to reflect Foundation API changes" - BuildrPHP/Collection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63797e...1550a8 )

by Zoltán

created 2016-01-06 08:54 UTC

Set::clear() A

↳ Parent: Set

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?php namespace BuildR\Collection;

use BuildR\Collection\Exception\CollectionException;
use BuildR\Collection\Interfaces\CollectionInterface;

/**
 * Set type (Collection implementation)
 * Sets only store scalar types
 *
 * BuildR PHP Framework
 *
 * @author Zoltán Borsos <[email protected]>
 * @package Collection
 *
 * @copyright    Copyright 2015, Zoltán Borsos.
 * @license      https://github.com/Zolli/BuildR/blob/master/LICENSE.md
 * @link         https://github.com/Zolli/BuildR
 */
class Set implements CollectionInterface {

    protected $data = [];

    private $position = 0;

    /**
     * Set constructor.
     *
     * @param null|array $values
     */
    public function __construct($values = NULL) {
        if(is_array($values)) {
            $this->addAll($values);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function toArray() {
        return $this->data;
    }

    /**
     * {@inheritdoc}
     */
    public function add($element) {
        if(!is_scalar($element)) {
            throw CollectionException::nonScalarTypeGiven(gettype($element));
        }

        $this->data[] = $element;
    }

    /**
     * {@inheritdoc}
     */
    public function addAll($elements) {
        $elements = $this->checkAndConvertInputCollection($elements);

        foreach($elements as $item) {
            $this->add($item);
        }
    }

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

    /**
     * {@inheritdoc}
     */
    public function contains($element) {
        return (array_search($element, $this->data, TRUE) === FALSE) ? FALSE : TRUE;
    }

    /**
     * {@inheritdoc}
     */
    public function containsAll($elements) {
        $elements = $this->checkAndConvertInputCollection($elements);

        $result = TRUE;

        foreach($elements as $item) {
            if($this->contains($item) === FALSE) {
                $result = FALSE;

                break;
            }
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function containsAny($elements) {
        $elements = $this->checkAndConvertInputCollection($elements);

        foreach($elements as $item) {
            if($this->contains($item) === TRUE) {
                return TRUE;
            }
        }

        return FALSE;
    }

    /**
     * {@inheritdoc}
     */
    public function equals(CollectionInterface $collection) {
        //First check the size, if this not equals the tow collection
        //not be identical
        if($collection->size() !== $this->size()) {
            return FALSE;
        }

        //Use strict comparison to check arrays are equals
        //(Values and orders)
        return $collection->toArray() === $this->data;
    }

    /**
     * {@inheritdoc}
     */
    public function isEmpty() {
        return empty($this->data);
    }

    /**
     * {@inheritdoc}
     */
    public function remove($element) {
        if(($index = array_search($element, $this->data)) !== FALSE) {
            unset($this->data[$index]);

            return TRUE;
        }

        return FALSE;
    }

    /**
     * {@inheritdoc}
     */
    public function removeAll($elements) {
        $elements = $this->checkAndConvertInputCollection($elements);

        $result = FALSE;

        foreach($elements as $item) {
            if($this->remove($item) === TRUE) {
                $result = TRUE;
            }
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function retainAll($elements) {
        $elements = $this->checkAndConvertInputCollection($elements);

        $result = FALSE;

        foreach($this->data as $index => $data) {
            if(array_search($data, $elements) === FALSE) {
                unset($this->data[$index]);

                $result = TRUE;
            }
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function size() {
        return (is_array($this->data)) ? count($this->data) : 0;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function current() {
        return $this->data[$this->position];
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function next() {
        $this->position++;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function key() {
        return $this->position;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function valid() {
        return isset($this->data[$this->position]);
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function rewind() {
        $this->position--;
    }

    /**
     * {@inheritdoc}
     */
    public function count() {
        return $this->size();
    }

    /**
     * @param array|\BuildR\Collection\Interfaces\CollectionInterface $elements
     *
     * @return array
     */
    protected function checkAndConvertInputCollection($elements) {
        if($elements instanceof CollectionInterface) {
            $elements = $elements->toArray();
        }

        return $elements;
    }

}


1			<?php namespace BuildR\Collection;
2
3			use BuildR\Collection\Exception\CollectionException;
4			use BuildR\Collection\Interfaces\CollectionInterface;
5
6			/**
7			* Set type (Collection implementation)
8			* Sets only store scalar types
9			*
10			* BuildR PHP Framework
11			*
12			* @author Zoltán Borsos <[email protected]>
13			* @package Collection
14			*
15			* @copyright Copyright 2015, Zoltán Borsos.
16			* @license https://github.com/Zolli/BuildR/blob/master/LICENSE.md
17			* @link https://github.com/Zolli/BuildR
18			*/
19			class Set implements CollectionInterface {
20
21			protected $data = [];
22
23			private $position = 0;
24
25			/**
26			* Set constructor.
27			*
28			* @param null\|array $values
29			*/
30	23		public function __construct($values = NULL) {
31	23		if(is_array($values)) {
32	5		$this->addAll($values);
33	5		}
34	23		}
35
36			/**
37			* {@inheritdoc}
38			*/
39	8		public function toArray() {
40	8		return $this->data;
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46	23		public function add($element) {
47	23		if(!is_scalar($element)) {
48	4		throw CollectionException::nonScalarTypeGiven(gettype($element));
49			}
50
51	19		$this->data[] = $element;
52	19		}
53
54			/**
55			* {@inheritdoc}
56			*/
57	17		public function addAll($elements) {
58	17		$elements = $this->checkAndConvertInputCollection($elements);
59
60	17		foreach($elements as $item) {
61	17		$this->add($item);
62	17		}
63	17		}
64
65			/**
66			* {@inheritdoc}
67			*/
68	1		public function clear() {
69	1		$this->data = [];
70	1		}
71
72			/**
73			* {@inheritdoc}
74			*/
75	9		public function contains($element) {
76	9		return (array_search($element, $this->data, TRUE) === FALSE) ? FALSE : TRUE;
77			}
78
79			/**
80			* {@inheritdoc}
81			*/
82	8	View Code Duplication	public function containsAll($elements) {
83	8		$elements = $this->checkAndConvertInputCollection($elements);
84
85	8		$result = TRUE;
86
87	8		foreach($elements as $item) {
88	8		if($this->contains($item) === FALSE) {
89	4		$result = FALSE;
90
91	4		break;
92			}
93	8		}
94
95	8		return $result;
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101	5		public function containsAny($elements) {
102	5		$elements = $this->checkAndConvertInputCollection($elements);
103
104	5		foreach($elements as $item) {
105	5		if($this->contains($item) === TRUE) {
106	4		return TRUE;
107			}
108	5		}
109
110	5		return FALSE;
111			}
112
113			/**
114			* {@inheritdoc}
115			*/
116	5		public function equals(CollectionInterface $collection) {
117			//First check the size, if this not equals the tow collection
118			//not be identical
119	5		if($collection->size() !== $this->size()) {
120	1		return FALSE;
121			}
122
123			//Use strict comparison to check arrays are equals
124			//(Values and orders)
125	4		return $collection->toArray() === $this->data;
126			}
127
128			/**
129			* {@inheritdoc}
130			*/
131	1		public function isEmpty() {
132	1		return empty($this->data);
133			}
134
135			/**
136			* {@inheritdoc}
137			*/
138	2		public function remove($element) {
139	2		if(($index = array_search($element, $this->data)) !== FALSE) {
140	2		unset($this->data[$index]);
141
142	2		return TRUE;
143			}
144
145	2		return FALSE;
146			}
147
148			/**
149			* {@inheritdoc}
150			*/
151	1	View Code Duplication	public function removeAll($elements) {
152	1		$elements = $this->checkAndConvertInputCollection($elements);
153
154	1		$result = FALSE;
155
156	1		foreach($elements as $item) {
157	1		if($this->remove($item) === TRUE) {
158	1		$result = TRUE;
159	1		}
160	1		}
161
162	1		return $result;
163			}
164
165			/**
166			* {@inheritdoc}
167			*/
168	1		public function retainAll($elements) {
169	1		$elements = $this->checkAndConvertInputCollection($elements);
170
171	1		$result = FALSE;
172
173	1		foreach($this->data as $index => $data) {
174	1		if(array_search($data, $elements) === FALSE) {
175	1		unset($this->data[$index]);
176
177	1		$result = TRUE;
178	1		}
179	1		}
180
181	1		return $result;
182			}
183
184			/**
185			* {@inheritdoc}
186			*/
187	12		public function size() {
188	12		return (is_array($this->data)) ? count($this->data) : 0;
189			}
190
191			/**
192			* {@inheritdoc}
193			*
194			* @codeCoverageIgnore
195			*/
196			public function current() {
197			return $this->data[$this->position];
198			}
199
200			/**
201			* {@inheritdoc}
202			*
203			* @codeCoverageIgnore
204			*/
205			public function next() {
206			$this->position++;
207			}
208
209			/**
210			* {@inheritdoc}
211			*
212			* @codeCoverageIgnore
213			*/
214			public function key() {
215			return $this->position;
216			}
217
218			/**
219			* {@inheritdoc}
220			*
221			* @codeCoverageIgnore
222			*/
223			public function valid() {
224			return isset($this->data[$this->position]);
225			}
226
227			/**
228			* {@inheritdoc}
229			*
230			* @codeCoverageIgnore
231			*/
232			public function rewind() {
233			$this->position--;
234			}
235
236			/**
237			* {@inheritdoc}
238			*/
239	7		public function count() {
240	7		return $this->size();
241			}
242
243			/**
244			* @param array\|\BuildR\Collection\Interfaces\CollectionInterface $elements
245			*
246			* @return array
247			*/
248	17		protected function checkAndConvertInputCollection($elements) {
249	17		if($elements instanceof CollectionInterface) {
250			$elements = $elements->toArray();
251			}
252
253	17		return $elements;
254			}
255
256			}
257

BuildrPHP / Collection

Push — master ( 63797e...1550a8 )

Set::clear() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like