ReferenceList::removeReferenceAtIndex() - Code Metrics - Inspection of "Fix ReferenceList not removing all reference with..." - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#634)

by Bene

created 2016-02-18 15:49 UTC

ReferenceList::removeReferenceAtIndex() A

↳ Parent: ReferenceList

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Wikibase\DataModel;

use ArrayIterator;
use Comparable;
use Countable;
use InvalidArgumentException;
use IteratorAggregate;
use Serializable;
use Traversable;
use Wikibase\DataModel\Internal\MapValueHasher;
use Wikibase\DataModel\Snak\Snak;

/**
 * List of Reference objects.
 *
 * @since 0.1
 * Does not implement References anymore since 2.0
 * Does not extend SplObjectStorage since 5.0
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 * @author H. Snater < [email protected] >
 * @author Thiemo Mättig
 * @author Bene* < [email protected] >
 */
class ReferenceList implements Comparable, Countable, IteratorAggregate, Serializable {

	/**
	 * @var Reference[]
	 */
	private $references = array();

	/**
	 * @param Reference[]|Traversable $references
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( $references = array() ) {
		if ( !is_array( $references ) && !( $references instanceof Traversable ) ) {
			throw new InvalidArgumentException( '$references must be an array or an instance of Traversable' );
		}

		foreach ( $references as $reference ) {
			if ( !( $reference instanceof Reference ) ) {
				throw new InvalidArgumentException( 'Every element in $references must be an instance of Reference' );
			}

			$this->addReference( $reference );
		}
	}

	/**
	 * Adds the provided reference to the list.
	 * Empty references are ignored.
	 *
	 * @since 0.1
	 *
	 * @param Reference $reference
	 * @param int|null $index
	 *
	 * @throws InvalidArgumentException
	 */
	public function addReference( Reference $reference, $index = null ) {
		if ( $index !== null && ( !is_int( $index ) || $index < 0 ) ) {
			throw new InvalidArgumentException( '$index must be a non-negative integer or null' );
		}

		if ( $reference->isEmpty() ) {
			return;
		}

		if ( $index === null || $index >= count( $this->references ) ) {
			// Append object to the end of the reference list.
			$this->references[] = $reference;
		} else {
			$this->insertReferenceAtIndex( $reference, $index );
		}
	}

	/**
	 * @since 1.1
	 *
	 * @param Snak[]|Snak $snaks
	 * @param Snak [$snak2,...]
	 *
	 * @throws InvalidArgumentException
	 */
	public function addNewReference( $snaks = array() /*...*/ ) {
		if ( $snaks instanceof Snak ) {
			$snaks = func_get_args();
		}

		$this->addReference( new Reference( $snaks ) );
	}

	/**
	 * @param Reference $reference
	 * @param int $index
	 */
	private function insertReferenceAtIndex( Reference $reference, $index ) {
		array_splice( $this->references, $index, 0, array( $reference ) );
	}

	/**
	 * Returns if the list contains a reference with the same hash as the provided reference.
	 *
	 * @since 0.1
	 *
	 * @param Reference $reference
	 *
	 * @return bool
	 */
	public function hasReference( Reference $reference ) {
		return $this->hasReferenceHash( $reference->getHash() );
	}

	/**
	 * Returns the index of the Reference object or false if the Reference could not be found.
	 *
	 * @since 0.5
	 *
	 * @param Reference $reference
	 *
	 * @return int|bool
	 */
	public function indexOf( Reference $reference ) {
		foreach ( $this->references as $index => $ref ) {
			if ( $ref === $reference ) {
				return $index;
			}
		}

		return false;
	}

	/**
	 * Removes the reference with the same hash as the provided reference if such a reference exists in the list.
	 *
	 * @since 0.1
	 *
	 * @param Reference $reference
	 */
	public function removeReference( Reference $reference ) {
		$this->removeReferenceHash( $reference->getHash() );
	}

	/**
	 * Returns if the list contains a reference with the provided hash.
	 *
	 * @since 0.3
	 *
	 * @param string $referenceHash
	 *
	 * @return bool
	 */
	public function hasReferenceHash( $referenceHash ) {
		return $this->getReference( $referenceHash ) !== null;
	}

	/**
	 * Looks for the first Reference object in this list with the provided hash.
	 * Removes all occurences of that object.
	 *
	 * @since 0.3
	 *
	 * @param string $referenceHash	`
	 */
	public function removeReferenceHash( $referenceHash ) {
		$reference = $this->getReference( $referenceHash );

		foreach ( $this->references as $index => $ref ) {
			if ( $ref === $reference ) {
				unset( $this->references[$index] );
			}
		}

		$this->references = array_values( $this->references );
	}

	/**
	 * Returns the first Reference object with the provided hash, or
	 * null if there is no such reference in the list.
	 *
	 * @since 0.3
	 *
	 * @param string $referenceHash
	 *
	 * @return Reference|null
	 */
	public function getReference( $referenceHash ) {
		foreach ( $this->references as $reference ) {
			if ( $reference->getHash() === $referenceHash ) {
				return $reference;
			}
		}

		return null;
	}

	/**
	 * @see Serializable::serialize
	 *
	 * @since 2.1
	 *
	 * @return string
	 */
	public function serialize() {
		return serialize( $this->references );
	}

	/**
	 * @see Serializable::unserialize
	 *
	 * @since 2.1
	 *
	 * @param string $serialized
	 */
	public function unserialize( $serialized ) {
		$this->references = unserialize( $serialized );
	}

	/**
	 * @since 4.4
	 *
	 * @return bool
	 */
	public function isEmpty() {
		return empty( $this->references );
	}

	/**
	 * The hash is purely valuer based. Order of the elements in the array is not held into account.
	 *
	 * @since 0.3
	 *
	 * @return string
	 */
	public function getValueHash() {
		$hasher = new MapValueHasher();
		return $hasher->hash( $this->references );
	}

	/**
	 * @see Comparable::equals
	 *
	 * The comparison is done purely value based, ignoring the order of the elements in the array.
	 *
	 * @since 0.3
	 *
	 * @param mixed $target
	 *
	 * @return bool
	 */
	public function equals( $target ) {
		if ( $this === $target ) {
			return true;
		}

		return $target instanceof self
		       && $this->getValueHash() === $target->getValueHash();
	}

	/**
	 * @see Countable::count
	 *
	 * @return int
	 */
	public function count() {
		return count( $this->references );
	}

	/**
	 * @see IteratorAggregate::getIterator
	 *
	 * @since 5.0
	 *
	 * @return Traversable
	 */
	public function getIterator() {
		return new ArrayIterator( $this->references );
	}

}


1		<?php
2
3		namespace Wikibase\DataModel;
4
5		use ArrayIterator;
6		use Comparable;
7		use Countable;
8		use InvalidArgumentException;
9		use IteratorAggregate;
10		use Serializable;
11		use Traversable;
12		use Wikibase\DataModel\Internal\MapValueHasher;
13		use Wikibase\DataModel\Snak\Snak;
14
15		/**
16		* List of Reference objects.
17		*
18		* @since 0.1
19		* Does not implement References anymore since 2.0
20		* Does not extend SplObjectStorage since 5.0
21		*
22		* @licence GNU GPL v2+
23		* @author Jeroen De Dauw < [email protected] >
24		* @author H. Snater < [email protected] >
25		* @author Thiemo Mättig
26		* @author Bene* < [email protected] >
27		*/
28		class ReferenceList implements Comparable, Countable, IteratorAggregate, Serializable {
29
30		/**
31		* @var Reference[]
32		*/
33		private $references = array();
34	29
35	29	/**
36	8	* @param Reference[]\|Traversable $references
37		*
38		* @throws InvalidArgumentException
39	21	*/
40	12	public function __construct( $references = array() ) {
41	4	if ( !is_array( $references ) && !( $references instanceof Traversable ) ) {
42		throw new InvalidArgumentException( '$references must be an array or an instance of Traversable' );
43		}
44	8
45	17	foreach ( $references as $reference ) {
46	17	if ( !( $reference instanceof Reference ) ) {
47		throw new InvalidArgumentException( 'Every element in $references must be an instance of Reference' );
48		}
49
50		$this->addReference( $reference );
51		}
52		}
53
54		/**
55		* Adds the provided reference to the list.
56		* Empty references are ignored.
57		*
58	14	* @since 0.1
59	14	*
60		* @param Reference $reference
61		* @param int\|null $index
62		*
63	14	* @throws InvalidArgumentException
64		*/
65	14	public function addReference( Reference $reference, $index = null ) {
66	14	if ( $index !== null && ( !is_int( $index ) \|\| $index < 0 ) ) {
67	2	throw new InvalidArgumentException( '$index must be a non-negative integer or null' );
68		}
69	14
70		if ( $reference->isEmpty() ) {
71		return;
72		}
73
74		if ( $index === null \|\| $index >= count( $this->references ) ) {
75		// Append object to the end of the reference list.
76		$this->references[] = $reference;
77	14	} else {
78	14	$this->insertReferenceAtIndex( $reference, $index );
79	14	}
80	14	}
81	14
82		/**
83		* @since 1.1
84		*
85		* @param Snak[]\|Snak $snaks
86		* @param Snak [$snak2,...]
87		*
88		* @throws InvalidArgumentException
89		*/
90		public function addNewReference( $snaks = array() /.../ ) {
91	6	if ( $snaks instanceof Snak ) {
92	6	$snaks = func_get_args();
93	5	}
94	5
95		$this->addReference( new Reference( $snaks ) );
96	6	}
97	5
98		/**
99		* @param Reference $reference
100		* @param int $index
101		*/
102		private function insertReferenceAtIndex( Reference $reference, $index ) {
103	2	array_splice( $this->references, $index, 0, array( $reference ) );
104	2	}
105	2
106		/**
107		* Returns if the list contains a reference with the same hash as the provided reference.
108	2	*
109	2	* @since 0.1
110	2	*
111	2	* @param Reference $reference
112	2	*
113		* @return bool
114	2	*/
115	2	public function hasReference( Reference $reference ) {
116	2	return $this->hasReferenceHash( $reference->getHash() );
117		}
118
119	2	/**
120		* Returns the index of the Reference object or false if the Reference could not be found.
121	2	*
122	2	* @since 0.5
123	2	*
124	2	* @param Reference $reference
125		*
126		* @return int\|bool
127		*/
128		public function indexOf( Reference $reference ) {
129		foreach ( $this->references as $index => $ref ) {
130		if ( $ref === $reference ) {
131		return $index;
132		}
133		}
134
135	6	return false;
136	6	}
137	6
138		/**
139		* Removes the reference with the same hash as the provided reference if such a reference exists in the list.
140		*
141		* @since 0.1
142		*
143		* @param Reference $reference
144		*/
145		public function removeReference( Reference $reference ) {
146		$this->removeReferenceHash( $reference->getHash() );
147		}
148
149	2	/**
150	2	* Returns if the list contains a reference with the provided hash.
151		*
152	2	* @since 0.3
153	1	*
154	1	* @param string $referenceHash
155		*
156	1	* @return bool
157	2	*/
158		public function hasReferenceHash( $referenceHash ) {
159	2	return $this->getReference( $referenceHash ) !== null;
160		}
161
162		/**
163		* Looks for the first Reference object in this list with the provided hash.
164		* Removes all occurences of that object.
165		*
166		* @since 0.3
167		*
168		* @param string $referenceHash `
169	3	*/
170	3	public function removeReferenceHash( $referenceHash ) {
171	3	$reference = $this->getReference( $referenceHash );
172
173		foreach ( $this->references as $index => $ref ) {
174		if ( $ref === $reference ) {
175		unset( $this->references[$index] );
176		}
177		}
178
179		$this->references = array_values( $this->references );
180		}
181
182	8	/**
183	8	* Returns the first Reference object with the provided hash, or
184		* null if there is no such reference in the list.
185		*
186		* @since 0.3
187		*
188		* @param string $referenceHash
189		*
190		* @return Reference\|null
191		*/
192		public function getReference( $referenceHash ) {
193	5	foreach ( $this->references as $reference ) {
194	5	if ( $reference->getHash() === $referenceHash ) {
195		return $reference;
196	5	}
197	3	}
198	3
199	5	return null;
200		}
201
202		/**
203		* @see Serializable::serialize
204		*
205		* @since 2.1
206		*
207		* @return string
208		*/
209		public function serialize() {
210	14	return serialize( $this->references );
211		}
212
213		/**
214	14	* @see Serializable::unserialize
215	10	*
216	10	* @since 2.1
217		*
218	9	* @param string $serialized
219		*/
220	9	public function unserialize( $serialized ) {
221		$this->references = unserialize( $serialized );
222		}
223
224		/**
225		* @since 4.4
226		*
227		* @return bool
228		*/
229		public function isEmpty() {
230	3	return empty( $this->references );
231	3	}
232
233		/**
234		* The hash is purely valuer based. Order of the elements in the array is not held into account.
235		*
236		* @since 0.3
237		*
238		* @return string
239		*/
240		public function getValueHash() {
241	3	$hasher = new MapValueHasher();
242	3	return $hasher->hash( $this->references );
243	3	}
244
245		/**
246		* @see Comparable::equals
247		*
248		* The comparison is done purely value based, ignoring the order of the elements in the array.
249		*
250	3	* @since 0.3
251	3	*
252		* @param mixed $target
253		*
254		* @return bool
255		*/
256		public function equals( $target ) {
257		if ( $this === $target ) {
258		return true;
259		}
260
261		return $target instanceof self
262		&& $this->getValueHash() === $target->getValueHash();
263		}
264
265		/**
266		* @see Countable::count
267		*
268		* @return int
269		*/
270		public function count() {
271		return count( $this->references );
272		}
273
274		/**
275		* @see IteratorAggregate::getIterator
276		*
277		* @since 5.0
278		*
279		* @return Traversable
280		*/
281		public function getIterator() {
282		return new ArrayIterator( $this->references );
283		}
284
285		}
286

wmde / WikibaseDataModel

Pull Request — master (#634)

ReferenceList::removeReferenceAtIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like