CollectionAbstract::clear() - Code Metrics - john-wilkinson/collections - Measure and Improve Code Quality continuously with Scrutinizer

CollectionAbstract::clear()
last analyzed 2016-04-16 21:35 UTC

↳ Parent: CollectionAbstract

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	1
nc	1

<?php
namespace Jmw\Collection;

/**
 * This class provides a skeletal implementation of the Collection interface, 
 * to minimize the effort required to implement this interface.
 * 
 * To implement an unmodifiable collection, the programmer needs only to extend this
 * class and provide implementations for the iterator and size methods, and use the ImmutableCollectionTrait trait
 * (The iterator returned by the iterator method must implement hasNext and next.)
 * @author john
 *
 */
abstract class CollectionAbstract implements CollectionInterface
{	

	/**
	 * Adds all of the elements in the specified collection to this collection (optional operation).
	 * @param CollectionInterface $collection
	 * @return boolean $changed
	*/
	public function addAll(CollectionInterface $collection)

	{
		$iterator = $collection->iterator();
		$changed = false;
		
		while($iterator->hasNext())
		{
			$changed = true;
			$this->add($iterator->next());
		}
		
		return $changed;		
	}
	
	/**
	 * Returns true if this collection contains the specified element.
	 * @return boolean
	*/
	public function contains($element)
	{
		$iterator = $this->iterator();
		
		while($iterator->hasNext())
		{
			if($element === $iterator->next())
			{
				return true;
			}
		}
		return false;
	}
	
	/**
	 * Returns true if this collection contains all of the elements in the specified collection.
	 * @param Collection $collection
	 * @return boolean
	*/
	public function containsAll(CollectionInterface $collection)
	{
		$iterator = $collection->iterator();
		
		while($iterator->hasNext())
		{
			if(!$this->contains($iterator->next()))
			{
				return false;
			}
		}
		
		return true;
	}
	
	/**
	 * Compares the specified object with this collection for equality.
	 * @param unknown $object
	 * @return boolean
	*/
	public function equals($object)
	{
		if(!$object instanceof CollectionInterface)
		{
			return false;
		}
		return $this->hashCode() === $object->hashCode();
	}
	
	/**
	 * Returns true if this collection contains no elements.
	 * @return boolean
	*/
	public function isEmpty()
	{
		return $this->size() === 0;
	}
	
	/**
	 * Retains only the elements in this collection that are contained in the specified collection (optional operation).
	 * @param CollectionInterface $collection
	 * @return boolean
	*/
	public function retainAll(CollectionInterface $collection)

	{
		$iterator = $this->iterator();
		$changed = false;
		
		while($iterator->hasNext())
		{
			if(!$collection->contains($iterator->next()))
			{
				$iterator->remove();
				$changed = true;
			}
		}
		return $changed;
	}

	/**
	 * Returns a json string representing all the elements in this collection
	 * @return string
	 */
	public function toJson()
	{
		$json = json_encode($this->toArray());
		if($error = json_last_error())
		{
			throw new \Exception('Error encoding to json: ' . $error);
		}
		return $json;
	}
	
	/**
	 * Ensures that this collection contains the specified element (optional operation).
	 * @param multitype $element
	 * @return boolean
	 */
	public abstract function add($element);

	
	/**
	 * Removes all of the elements from this collection (optional operation).
	 * @return void
	 */
	public abstract function clear();


	/**
	 * Returns an iterator over the elements in this collection.
	 * @return IteratorInterface
	 */
	public abstract function iterator();

	
	/**
	 * Removes a single instance of the specified element from this collection, if it is present (optional operation).
	 * @param multitype $element
	 * @return boolean
	*/
	public abstract function remove($element);

	
	/**
	 * Removes all of this collection's elements that are also contained in the specified collection (optional operation).
	 * @param CollectionInterface $collection
	 * @return boolean
	*/
	public abstract function removeAll(CollectionInterface $collection);

	
	/**
	 * Returns the number of elements in this collection.
	 * @return int
	*/
	public abstract function size();

	
	/**
	 * Returns an array containing all of the elements in this collection.
	 * @return array
	*/
	public abstract function toArray();

	
	/**
	 * Returns the hash code value for this collection.
	 * @return string
	 */
	public abstract function hashCode();

}

1		<?php
2		namespace Jmw\Collection;
3
4		/**
5		* This class provides a skeletal implementation of the Collection interface,
6		* to minimize the effort required to implement this interface.
7		*
8		* To implement an unmodifiable collection, the programmer needs only to extend this
9		* class and provide implementations for the iterator and size methods, and use the ImmutableCollectionTrait trait
10		* (The iterator returned by the iterator method must implement hasNext and next.)
11		* @author john
12		*
13		*/
14		abstract class CollectionAbstract implements CollectionInterface
15		{
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The opening class brace should be on a newline by itself. Loading history...
16		/**
17		* Adds all of the elements in the specified collection to this collection (optional operation).
18		* @param CollectionInterface $collection
19		* @return boolean $changed
20		*/
21	View Code Duplication	public function addAll(CollectionInterface $collection)
		0 ignored issues – show Duplication introduced 2016-04-16 03:05 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...
22		{
23		$iterator = $collection->iterator();
24		$changed = false;
25
26		while($iterator->hasNext())
27		{
28		$changed = true;
29		$this->add($iterator->next());
30		}
31
32		return $changed;
33		}
34
35		/**
36		* Returns true if this collection contains the specified element.
37		* @return boolean
38		*/
39		public function contains($element)
40		{
41		$iterator = $this->iterator();
42
43		while($iterator->hasNext())
44		{
45		if($element === $iterator->next())
46		{
47		return true;
48		}
49		}
50		return false;
51		}
52
53		/**
54		* Returns true if this collection contains all of the elements in the specified collection.
55		* @param Collection $collection
56		* @return boolean
57		*/
58		public function containsAll(CollectionInterface $collection)
59		{
60		$iterator = $collection->iterator();
61
62		while($iterator->hasNext())
63		{
64		if(!$this->contains($iterator->next()))
65		{
66		return false;
67		}
68		}
69
70		return true;
71		}
72
73		/**
74		* Compares the specified object with this collection for equality.
75		* @param unknown $object
76		* @return boolean
77		*/
78		public function equals($object)
79		{
80		if(!$object instanceof CollectionInterface)
81		{
82		return false;
83		}
84		return $this->hashCode() === $object->hashCode();
85		}
86
87		/**
88		* Returns true if this collection contains no elements.
89		* @return boolean
90		*/
91		public function isEmpty()
92		{
93		return $this->size() === 0;
94		}
95
96		/**
97		* Retains only the elements in this collection that are contained in the specified collection (optional operation).
98		* @param CollectionInterface $collection
99		* @return boolean
100		*/
101	View Code Duplication	public function retainAll(CollectionInterface $collection)
		0 ignored issues – show Duplication introduced 2016-04-16 03:05 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...
102		{
103		$iterator = $this->iterator();
104		$changed = false;
105
106		while($iterator->hasNext())
107		{
108		if(!$collection->contains($iterator->next()))
109		{
110		$iterator->remove();
111		$changed = true;
112		}
113		}
114		return $changed;
115		}
116
117		/**
118		* Returns a json string representing all the elements in this collection
119		* @return string
120		*/
121		public function toJson()
122		{
123		$json = json_encode($this->toArray());
124		if($error = json_last_error())
125		{
126		throw new \Exception('Error encoding to json: ' . $error);
127		}
128		return $json;
129		}
130
131		/**
132		* Ensures that this collection contains the specified element (optional operation).
133		* @param multitype $element
134		* @return boolean
135		*/
136		public abstract function add($element);
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
137
138		/**
139		* Removes all of the elements from this collection (optional operation).
140		* @return void
141		*/
142		public abstract function clear();
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
143
144		/**
145		* Returns an iterator over the elements in this collection.
146		* @return IteratorInterface
147		*/
148		public abstract function iterator();
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
149
150		/**
151		* Removes a single instance of the specified element from this collection, if it is present (optional operation).
152		* @param multitype $element
153		* @return boolean
154		*/
155		public abstract function remove($element);
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
156
157		/**
158		* Removes all of this collection's elements that are also contained in the specified collection (optional operation).
159		* @param CollectionInterface $collection
160		* @return boolean
161		*/
162		public abstract function removeAll(CollectionInterface $collection);
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
163
164		/**
165		* Returns the number of elements in this collection.
166		* @return int
167		*/
168		public abstract function size();
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
169
170		/**
171		* Returns an array containing all of the elements in this collection.
172		* @return array
173		*/
174		public abstract function toArray();
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
175
176		/**
177		* Returns the hash code value for this collection.
178		* @return string
179		*/
180		public abstract function hashCode();
		0 ignored issues – show Coding Style introduced 2016-04-16 03:05 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
181		}

john-wilkinson / collections

CollectionAbstract::clear() last analyzed 2016-04-16 21:35 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CollectionAbstract::clear()
last analyzed 2016-04-16 21:35 UTC