HashArray::offsetSet() - Code Metrics - Inspection of "Merge pull request #711 from wmde/indicesAreUpToDa..." - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 344106...7b50af )

by Jeroen De

created 2017-01-11 12:46 UTC

HashArray::offsetSet() A

↳ Parent: HashArray

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

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	2
nc	1
nop	2
crap	1

<?php

namespace Wikibase\DataModel;

use ArrayObject;
use Comparable;
use Hashable;
use InvalidArgumentException;
use Traversable;
use Wikibase\DataModel\Internal\MapValueHasher;

/**
 * Generic array object with lookups based on hashes of the elements.
 *
 * Elements need to implement Hashable.
 *
 * Note that by default the getHash method uses @see MapValueHashesr
 * which returns a hash based on the contents of the list, regardless
 * of order and keys.
 *
 * Also note that if the Hashable elements are mutable, any modifications
 * made to them via their mutator methods will not cause an update of
 * their associated hash in this array.
 *
 * When acceptDuplicates is set to true, multiple elements with the same
 * hash can reside in the HashArray. Lookup by such a non-unique hash will
 * return only the first element and deletion will also delete only
 * the first such element.
 *
 * @since 0.1
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < [email protected] >
 */
abstract class HashArray extends ArrayObject implements Hashable, Comparable {

	/**
	 * Maps element hashes to their offsets.
	 *
	 * @since 0.1
	 *
	 * @var array [ element hash (string) => array [ element offset (string|int) ] | element offset (string|int) ]
	 */
	protected $offsetHashes = [];

	/**
	 * If duplicate values (based on hash) should be accepted or not.
	 *
	 * @since 0.3
	 *
	 * @var bool
	 */
	protected $acceptDuplicates = false;

	/**
	 * @var integer
	 */
	protected $indexOffset = 0;

	/**
	 * Returns the name of an interface/class that the element should implement/extend.
	 *
	 * @since 0.4
	 *
	 * @return string
	 */
	abstract public function getObjectType();

	/**
	 * @see ArrayObject::__construct
	 *
	 * @param array|Traversable|null $input
	 * @param int $flags
	 * @param string $iteratorClass
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( $input = null, $flags = 0, $iteratorClass = 'ArrayIterator' ) {
		parent::__construct( [], $flags, $iteratorClass );

		if ( $input !== null ) {
			if ( !is_array( $input ) && !( $input instanceof Traversable ) ) {
				throw new InvalidArgumentException( '$input must be an array or Traversable' );
			}

			foreach ( $input as $offset => $value ) {
				$this->offsetSet( $offset, $value );
			}
		}
	}

	/**
	 * Finds a new offset for when appending an element.
	 * The base class does this, so it would be better to integrate,
	 * but there does not appear to be any way to do this...
	 *
	 * @return integer
	 */
	protected function getNewOffset() {
		while ( $this->offsetExists( $this->indexOffset ) ) {
			$this->indexOffset++;
		}

		return $this->indexOffset;
	}

	/**
	 * Gets called before a new element is added to the ArrayObject.
	 *
	 * At this point the index is always set (ie not null) and the
	 * value is always of the type returned by @see getObjectType.
	 *
	 * Should return a boolean. When false is returned the element
	 * does not get added to the ArrayObject.
	 *
	 * @since 0.1
	 *
	 * @param int|string $index
	 * @param Hashable $hashable
	 *
	 * @return bool
	 */
	protected function preSetElement( $index, $hashable ) {
		$hash = $hashable->getHash();

		$hasHash = $this->hasElementHash( $hash );

		if ( !$this->acceptDuplicates && $hasHash ) {
			return false;
		}
		else {
			if ( $hasHash ) {
				if ( !is_array( $this->offsetHashes[$hash] ) ) {
					$this->offsetHashes[$hash] = [ $this->offsetHashes[$hash] ];
				}

				$this->offsetHashes[$hash][] = $index;
			}
			else {
				$this->offsetHashes[$hash] = $index;
			}

			return true;
		}
	}

	/**
	 * Returns if there is an element with the provided hash.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 *
	 * @return bool
	 */
	public function hasElementHash( $elementHash ) {
		return array_key_exists( $elementHash, $this->offsetHashes );
	}

	/**
	 * Returns if there is an element with the same hash as the provided element in the list.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 *
	 * @return bool
	 */
	public function hasElement( Hashable $element ) {
		return $this->hasElementHash( $element->getHash() );
	}

	/**
	 * Removes the element with the hash of the provided element, if there is such an element in the list.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 */
	public function removeElement( Hashable $element ) {
		$this->removeByElementHash( $element->getHash() );
	}

	/**
	 * Removes the element with the provided hash, if there is such an element in the list.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 */
	public function removeByElementHash( $elementHash ) {
		if ( $this->hasElementHash( $elementHash ) ) {
			$offset = $this->offsetHashes[$elementHash];

			if ( is_array( $offset ) ) {
				$offset = reset( $offset );
			}

			$this->offsetUnset( $offset );
		}
	}

	/**
	 * Adds the provided element to the list if there is no element with the same hash yet.
	 *
	 * @since 0.1
	 *
	 * @param Hashable $element
	 *
	 * @return bool Indicates if the element was added or not.
	 */
	public function addElement( Hashable $element ) {
		$append = $this->acceptDuplicates || !$this->hasElementHash( $element->getHash() );

		if ( $append ) {
			$this->append( $element );
		}

		return $append;
	}

	/**
	 * Returns the element with the provided hash or false if there is no such element.
	 *
	 * @since 0.1
	 *
	 * @param string $elementHash
	 *
	 * @return mixed|bool
	 */
	public function getByElementHash( $elementHash ) {
		if ( $this->hasElementHash( $elementHash ) ) {
			$offset = $this->offsetHashes[$elementHash];

			if ( is_array( $offset ) ) {
				$offset = reset( $offset );
			}

			return $this->offsetGet( $offset );
		}
		else {
			return false;
		}
	}

	/**
	 * @see ArrayObject::offsetUnset
	 *
	 * @since 0.1
	 *
	 * @param mixed $index
	 */
	public function offsetUnset( $index ) {
		if ( $this->offsetExists( $index ) ) {
			/**
			 * @var Hashable $element
			 */
			$element = $this->offsetGet( $index );

			$hash = $element->getHash();

			if ( array_key_exists( $hash, $this->offsetHashes )
				&& is_array( $this->offsetHashes[$hash] )
				&& count( $this->offsetHashes[$hash] ) > 1 ) {
				$this->offsetHashes[$hash] = array_filter(
					$this->offsetHashes[$hash],
					function( $value ) use ( $index ) {
						return $value !== $index;
					}
				);
			}
			else {
				unset( $this->offsetHashes[$hash] );
			}

			parent::offsetUnset( $index );
		}
	}

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

	/**
	 * @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->getHash() === $target->getHash();
	}

	/**
	 * Removes duplicates bases on hash value.
	 *
	 * @since 0.3
	 */
	public function removeDuplicates() {
		$knownHashes = [];

		/**
		 * @var Hashable $hashable
		 */
		foreach ( iterator_to_array( $this ) as $hashable ) {
			$hash = $hashable->getHash();

			if ( in_array( $hash, $knownHashes ) ) {
				$this->removeByElementHash( $hash );
			}
			else {
				$knownHashes[] = $hash;
			}
		}
	}

	/**
	 * @see ArrayObject::append
	 *
	 * @param mixed $value
	 */
	public function append( $value ) {
		$this->setElement( null, $value );
	}

	/**
	 * @see ArrayObject::offsetSet()
	 *
	 * @param mixed $index
	 * @param mixed $value
	 */
	public function offsetSet( $index, $value ) {
		$this->setElement( $index, $value );
	}

	/**
	 * Returns if the provided value has the same type as the elements
	 * that can be added to this ArrayObject.
	 *
	 * @param mixed $value
	 *
	 * @return bool
	 */
	protected function hasValidType( $value ) {
		$class = $this->getObjectType();
		return $value instanceof $class;
	}

	/**
	 * Method that actually sets the element and holds
	 * all common code needed for set operations, including
	 * type checking and offset resolving.
	 *
	 * If you want to do additional indexing or have code that
	 * otherwise needs to be executed whenever an element is added,
	 * you can overload @see preSetElement.
	 *
	 * @param mixed $index
	 * @param mixed $value
	 *
	 * @throws InvalidArgumentException
	 */
	protected function setElement( $index, $value ) {
		if ( !$this->hasValidType( $value ) ) {
			$type = is_object( $value ) ? get_class( $value ) : gettype( $value );

			throw new InvalidArgumentException( '$value must be an instance of ' . $this->getObjectType() . '; got ' . $type );
		}

		if ( $index === null ) {
			$index = $this->getNewOffset();
		}

		if ( $this->preSetElement( $index, $value ) ) {
			parent::offsetSet( $index, $value );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		}
	}

	/**
	 * @see Serializable::serialize
	 *
	 * @return string
	 */
	public function serialize() {
		return serialize( [
			'data' => $this->getArrayCopy(),
			'index' => $this->indexOffset,
		] );
	}

	/**
	 * @see Serializable::unserialize
	 *
	 * @param string $serialized
	 */
	public function unserialize( $serialized ) {
		$serializationData = unserialize( $serialized );

		foreach ( $serializationData['data'] as $offset => $value ) {
			// Just set the element, bypassing checks and offset resolving,
			// as these elements have already gone through this.
			parent::offsetSet( $offset, $value );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		}

		$this->indexOffset = $serializationData['index'];
	}

	/**
	 * Returns if the ArrayObject has no elements.
	 *
	 * @return bool
	 */
	public function isEmpty() {
		return !$this->getIterator()->valid();
	}

}


1		<?php
2
3		namespace Wikibase\DataModel;
4
5		use ArrayObject;
6		use Comparable;
7		use Hashable;
8		use InvalidArgumentException;
9		use Traversable;
10		use Wikibase\DataModel\Internal\MapValueHasher;
11
12		/**
13		* Generic array object with lookups based on hashes of the elements.
14		*
15		* Elements need to implement Hashable.
16		*
17		* Note that by default the getHash method uses @see MapValueHashesr
18		* which returns a hash based on the contents of the list, regardless
19		* of order and keys.
20		*
21		* Also note that if the Hashable elements are mutable, any modifications
22		* made to them via their mutator methods will not cause an update of
23		* their associated hash in this array.
24		*
25		* When acceptDuplicates is set to true, multiple elements with the same
26		* hash can reside in the HashArray. Lookup by such a non-unique hash will
27		* return only the first element and deletion will also delete only
28		* the first such element.
29		*
30		* @since 0.1
31		*
32		* @license GPL-2.0+
33		* @author Jeroen De Dauw < [email protected] >
34		*/
35		abstract class HashArray extends ArrayObject implements Hashable, Comparable {
36
37		/**
38		* Maps element hashes to their offsets.
39		*
40		* @since 0.1
41		*
42		* @var array [ element hash (string) => array [ element offset (string\|int) ] \| element offset (string\|int) ]
43		*/
44		protected $offsetHashes = [];
45
46		/**
47		* If duplicate values (based on hash) should be accepted or not.
48		*
49		* @since 0.3
50		*
51		* @var bool
52		*/
53		protected $acceptDuplicates = false;
54
55		/**
56		* @var integer
57		*/
58		protected $indexOffset = 0;
59
60		/**
61		* Returns the name of an interface/class that the element should implement/extend.
62		*
63		* @since 0.4
64		*
65		* @return string
66		*/
67		abstract public function getObjectType();
68
69		/**
70		* @see ArrayObject::__construct
71		*
72		* @param array\|Traversable\|null $input
73		* @param int $flags
74		* @param string $iteratorClass
75		*
76		* @throws InvalidArgumentException
77		*/
78		public function __construct( $input = null, $flags = 0, $iteratorClass = 'ArrayIterator' ) {
79		parent::__construct( [], $flags, $iteratorClass );
80
81		if ( $input !== null ) {
82		if ( !is_array( $input ) && !( $input instanceof Traversable ) ) {
83		throw new InvalidArgumentException( '$input must be an array or Traversable' );
84		}
85
86		foreach ( $input as $offset => $value ) {
87		$this->offsetSet( $offset, $value );
88		}
89		}
90		}
91
92		/**
93		* Finds a new offset for when appending an element.
94		* The base class does this, so it would be better to integrate,
95		* but there does not appear to be any way to do this...
96		*
97		* @return integer
98		*/
99		protected function getNewOffset() {
100	8	while ( $this->offsetExists( $this->indexOffset ) ) {
101	8	$this->indexOffset++;
102	8	}
103	8
104		return $this->indexOffset;
105	8	}
106
107		/**
108		* Gets called before a new element is added to the ArrayObject.
109		*
110		* At this point the index is always set (ie not null) and the
111		* value is always of the type returned by @see getObjectType.
112		*
113		* Should return a boolean. When false is returned the element
114		* does not get added to the ArrayObject.
115		*
116		* @since 0.1
117		*
118		* @param int\|string $index
119		* @param Hashable $hashable
120		*
121		* @return bool
122		*/
123		protected function preSetElement( $index, $hashable ) {
124	8	$hash = $hashable->getHash();
125	8
126		$hasHash = $this->hasElementHash( $hash );
127	8
128		if ( !$this->acceptDuplicates && $hasHash ) {
129	8	return false;
130		}
131		else {
132		if ( $hasHash ) {
133	8	if ( !is_array( $this->offsetHashes[$hash] ) ) {
134	4	$this->offsetHashes[$hash] = [ $this->offsetHashes[$hash] ];
135	2	}
136	2
137		$this->offsetHashes[$hash][] = $index;
138	4	}
139	4	else {
140		$this->offsetHashes[$hash] = $index;
141	4	}
142
143		return true;
144	8	}
145		}
146
147		/**
148		* Returns if there is an element with the provided hash.
149		*
150		* @since 0.1
151		*
152		* @param string $elementHash
153		*
154		* @return bool
155		*/
156		public function hasElementHash( $elementHash ) {
157	21	return array_key_exists( $elementHash, $this->offsetHashes );
158	21	}
159
160		/**
161		* Returns if there is an element with the same hash as the provided element in the list.
162		*
163		* @since 0.1
164		*
165		* @param Hashable $element
166		*
167		* @return bool
168		*/
169		public function hasElement( Hashable $element ) {
170	12	return $this->hasElementHash( $element->getHash() );
171	12	}
172
173		/**
174		* Removes the element with the hash of the provided element, if there is such an element in the list.
175		*
176		* @since 0.1
177		*
178		* @param Hashable $element
179		*/
180		public function removeElement( Hashable $element ) {
181	8	$this->removeByElementHash( $element->getHash() );
182	8	}
183	8
184		/**
185		* Removes the element with the provided hash, if there is such an element in the list.
186		*
187		* @since 0.1
188		*
189		* @param string $elementHash
190		*/
191		public function removeByElementHash( $elementHash ) {
192	9	if ( $this->hasElementHash( $elementHash ) ) {
193	9	$offset = $this->offsetHashes[$elementHash];
194	9
195		if ( is_array( $offset ) ) {
196	9	$offset = reset( $offset );
197	3	}
198	3
199		$this->offsetUnset( $offset );
200	9	}
201	9	}
202	9
203		/**
204		* Adds the provided element to the list if there is no element with the same hash yet.
205		*
206		* @since 0.1
207		*
208		* @param Hashable $element
209		*
210		* @return bool Indicates if the element was added or not.
211		*/
212		public function addElement( Hashable $element ) {
213	12	$append = $this->acceptDuplicates \|\| !$this->hasElementHash( $element->getHash() );
214	12
215		if ( $append ) {
216	12	$this->append( $element );
217	8	}
218	8
219		return $append;
220	12	}
221
222		/**
223		* Returns the element with the provided hash or false if there is no such element.
224		*
225		* @since 0.1
226		*
227		* @param string $elementHash
228		*
229		* @return mixed\|bool
230		*/
231		public function getByElementHash( $elementHash ) {
232		if ( $this->hasElementHash( $elementHash ) ) {
233		$offset = $this->offsetHashes[$elementHash];
234
235		if ( is_array( $offset ) ) {
236		$offset = reset( $offset );
237		}
238
239		return $this->offsetGet( $offset );
240		}
241		else {
242		return false;
243		}
244		}
245
246		/**
247		* @see ArrayObject::offsetUnset
248		*
249		* @since 0.1
250		*
251		* @param mixed $index
252		*/
253		public function offsetUnset( $index ) {
254	13	if ( $this->offsetExists( $index ) ) {
255	13	/**
256		* @var Hashable $element
257		*/
258		$element = $this->offsetGet( $index );
259	13
260		$hash = $element->getHash();
261	13
262		if ( array_key_exists( $hash, $this->offsetHashes )
263	13	&& is_array( $this->offsetHashes[$hash] )
264	13	&& count( $this->offsetHashes[$hash] ) > 1 ) {
265	13	$this->offsetHashes[$hash] = array_filter(
266	3	$this->offsetHashes[$hash],
267	3	function( $value ) use ( $index ) {
268	3	return $value !== $index;
269	3	}
270		);
271	3	}
272	3	else {
273		unset( $this->offsetHashes[$hash] );
274	12	}
275
276		parent::offsetUnset( $index );
277	13	}
278	13	}
279	13
280		/**
281		* @see Hashable::getHash
282		*
283		* The hash is purely valuer based. Order of the elements in the array is not held into account.
284		*
285		* @since 0.1
286		*
287		* @return string
288		*/
289		public function getHash() {
290	4	$hasher = new MapValueHasher();
291	4	return $hasher->hash( $this );
292	4	}
293
294		/**
295		* @see Comparable::equals
296		*
297		* The comparison is done purely value based, ignoring the order of the elements in the array.
298		*
299		* @since 0.3
300		*
301		* @param mixed $target
302		*
303		* @return bool
304		*/
305		public function equals( $target ) {
306	4	if ( $this === $target ) {
307	4	return true;
308	4	}
309
310		return $target instanceof self
311		&& $this->getHash() === $target->getHash();
312	4	}
313
314		/**
315		* Removes duplicates bases on hash value.
316		*
317		* @since 0.3
318		*/
319		public function removeDuplicates() {
320	12	$knownHashes = [];
321	12
322		/**
323		* @var Hashable $hashable
324		*/
325		foreach ( iterator_to_array( $this ) as $hashable ) {
326	12	$hash = $hashable->getHash();
327	12
328		if ( in_array( $hash, $knownHashes ) ) {
329	12	$this->removeByElementHash( $hash );
330	3	}
331	3	else {
332		$knownHashes[] = $hash;
333	12	}
334		}
335	12	}
336	12
337		/**
338		* @see ArrayObject::append
339		*
340		* @param mixed $value
341		*/
342		public function append( $value ) {
343		$this->setElement( null, $value );
344		}
345
346		/**
347		* @see ArrayObject::offsetSet()
348		*
349		* @param mixed $index
350	4	* @param mixed $value
351	4	*/
352	4	public function offsetSet( $index, $value ) {
353		$this->setElement( $index, $value );
354	4	}
355
356	4	/**
357	4	* Returns if the provided value has the same type as the elements
358		* that can be added to this ArrayObject.
359	4	*
360	4	* @param mixed $value
361		*
362	4	* @return bool
363		*/
364		protected function hasValidType( $value ) {
365		$class = $this->getObjectType();
366		return $value instanceof $class;
367		}
368
369		/**
370	4	* Method that actually sets the element and holds
371	4	* all common code needed for set operations, including
372		* type checking and offset resolving.
373	4	*
374		* If you want to do additional indexing or have code that
375	4	* otherwise needs to be executed whenever an element is added,
376	4	* you can overload @see preSetElement.
377	4	*
378	4	* @param mixed $index
379	4	* @param mixed $value
380		*
381		* @throws InvalidArgumentException
382		*/
383		protected function setElement( $index, $value ) {
384		if ( !$this->hasValidType( $value ) ) {
385		$type = is_object( $value ) ? get_class( $value ) : gettype( $value );
386	8
387	8	throw new InvalidArgumentException( '$value must be an instance of ' . $this->getObjectType() . '; got ' . $type );
388	8	}
389
390		if ( $index === null ) {
391		$index = $this->getNewOffset();
392		}
393
394		if ( $this->preSetElement( $index, $value ) ) {
395		parent::offsetSet( $index, $value );
		0 ignored issues – show Comprehensibility Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `setElement()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
396	4	}
397	4	}
398	4
399		/**
400		* @see Serializable::serialize
401		*
402		* @return string
403		*/
404		public function serialize() {
405		return serialize( [
406		'data' => $this->getArrayCopy(),
407		'index' => $this->indexOffset,
408	8	] );
409	8	}
410	8
411		/**
412		* @see Serializable::unserialize
413		*
414		* @param string $serialized
415		*/
416		public function unserialize( $serialized ) {
417		$serializationData = unserialize( $serialized );
418
419		foreach ( $serializationData['data'] as $offset => $value ) {
420		// Just set the element, bypassing checks and offset resolving,
421		// as these elements have already gone through this.
422		parent::offsetSet( $offset, $value );
		0 ignored issues – show Comprehensibility Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `unserialize()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
423		}
424
425		$this->indexOffset = $serializationData['index'];
426		}
427	8
428	8	/**
429		* Returns if the ArrayObject has no elements.
430		*
431		* @return bool
432		*/
433		public function isEmpty() {
434	8	return !$this->getIterator()->valid();
435	8	}
436	8
437		}
438

wmde / WikibaseDataModel

Push — master ( 344106...7b50af )

HashArray::offsetSet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like