ByPropertyIdArray::getPropertyGroupIndex() - Code Metrics - Inspection of "Deprecate Statement::getWithUniqueMainSnaks and re..." - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#666)

by no

created 2016-05-11 09:29 UTC

ByPropertyIdArray::getPropertyGroupIndex() A

↳ Parent: ByPropertyIdArray

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0175

Metric	Value
dl	0
loc	13
ccs	7
cts	8
cp	0.875
rs	9.4285
cc	3
eloc	8
nc	3
nop	1
crap	3.0175

<?php

namespace Wikibase\DataModel;

use ArrayObject;
use OutOfBoundsException;
use RuntimeException;
use Traversable;
use Wikibase\DataModel\Entity\PropertyId;

/**
 * Helper for managing objects indexed by property id.
 *
 * This is a light weight alternative approach to using something
 * like GenericArrayObject with the advantages that no extra interface
 * is needed and that indexing does not happen automatically.
 *
 * Lack of automatic indexing means that you will need to call the
 * buildIndex method before doing any look-ups.
 *
 * Since no extra interface is used, the user is responsible for only
 * adding objects that have a getPropertyId method that returns either
 * a string or integer when called with no arguments.
 *
 * Objects may be added or moved within the structure. Absolute indices (indices according to the
 * flat list of objects) may be specified to add or move objects. These management operations take
 * the property grouping into account. Adding or moving objects outside their "property groups"
 * shifts the whole group towards that index.
 *
 * Example of moving an object within its "property group":
 * o1 (p1)                           o1 (p1)
 * o2 (p2)                       /-> o3 (p2)
 * o3 (p2) ---> move to index 1 -/   o2 (p2)
 *
 * Example of moving an object that triggers moving the whole "property group":
 * o1 (p1)                       /-> o3 (p2)
 * o2 (p2)                       |   o2 (p2)
 * o3 (p2) ---> move to index 0 -/   o1 (p1)
 *
 * @since 0.2
 * @deprecated since 5.0, use a DataModel Service instead
 *
 * @license GPL-2.0+
 * @author H. Snater < [email protected] >
 */
class ByPropertyIdArray extends ArrayObject {

	/**
	 * @var array[]|null
	 */
	private $byId = null;

	/**
	 * @see ArrayObject::__construct
	 *
	 * @param PropertyIdProvider[]|Traversable|null $input
	 */
	public function __construct( $input = null ) {
		parent::__construct( (array)$input );
	}

	/**
	 * Builds the index for doing look-ups by property id.
	 *
	 * @since 0.2
	 */
	public function buildIndex() {
		$this->byId = array();

		/** @var PropertyIdProvider $object */
		foreach ( $this as $object ) {
			$propertyId = $object->getPropertyId()->getSerialization();

			if ( !array_key_exists( $propertyId, $this->byId ) ) {
				$this->byId[$propertyId] = array();
			}

			$this->byId[$propertyId][] = $object;
		}
	}

	/**
	 * Checks whether id indexed array has been generated.
	 *
	 * @throws RuntimeException
	 */
	private function assertIndexIsBuild() {
		if ( $this->byId === null ) {
			throw new RuntimeException( 'Index not build, call buildIndex first' );
		}
	}

	/**
	 * Returns the property ids used for indexing.
	 *
	 * @since 0.2
	 *
	 * @return PropertyId[]
	 * @throws RuntimeException
	 */
	public function getPropertyIds() {
		$this->assertIndexIsBuild();

		return array_map(
			function( $serializedPropertyId ) {
				return new PropertyId( $serializedPropertyId );
			},
			array_keys( $this->byId )
		);
	}

	/**
	 * Returns the objects featuring the provided property id in the index.
	 *
	 * @since 0.2
	 *
	 * @param PropertyId $propertyId
	 *
	 * @throws OutOfBoundsException
	 * @throws RuntimeException
	 * @return PropertyIdProvider[]
	 */
	public function getByPropertyId( PropertyId $propertyId ) {
		$this->assertIndexIsBuild();

		if ( !( array_key_exists( $propertyId->getSerialization(), $this->byId ) ) ) {
			throw new OutOfBoundsException( "Object with propertyId \"$propertyId\" not found" );
		}

		return $this->byId[$propertyId->getSerialization()];
	}

	/**
	 * Returns the absolute index of an object or false if the object could not be found.
	 * @since 0.5
	 *
	 * @param PropertyIdProvider $object
	 *
	 * @return bool|int
	 * @throws RuntimeException
	 */
	public function getFlatArrayIndexOfObject( $object ) {
		$this->assertIndexIsBuild();

		$i = 0;
		foreach ( $this as $o ) {
			if ( $o === $object ) {
				return $i;
			}
			$i++;
		}
		return false;
	}

	/**
	 * Returns the objects in a flat array (using the indexed form for generating the array).
	 * @since 0.5
	 *
	 * @return PropertyIdProvider[]
	 * @throws RuntimeException
	 */
	public function toFlatArray() {
		$this->assertIndexIsBuild();

		$array = array();
		foreach ( $this->byId as $objects ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$array = array_merge( $array, $objects );
		}
		return $array;
	}

	/**
	 * Returns the absolute numeric indices of objects featuring the same property id.
	 *
	 * @param PropertyId $propertyId
	 *
	 * @throws RuntimeException
	 * @return int[]
	 */
	private function getFlatArrayIndices( PropertyId $propertyId ) {
		$this->assertIndexIsBuild();

		$propertyIndices = array();
		$i = 0;

		foreach ( $this->byId as $serializedPropertyId => $objects ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			if ( $serializedPropertyId === $propertyId->getSerialization() ) {
				$propertyIndices = range( $i, $i + count( $objects ) - 1 );
				break;
			} else {
				$i += count( $objects );
			}
		}

		return $propertyIndices;
	}

	/**
	 * Moves an object within its "property group".
	 *
	 * @param PropertyIdProvider $object
	 * @param int $toIndex Absolute index within a "property group".
	 *
	 * @throws OutOfBoundsException
	 */
	private function moveObjectInPropertyGroup( $object, $toIndex ) {
		$currentIndex = $this->getFlatArrayIndexOfObject( $object );

		if ( $toIndex === $currentIndex ) {
			return;
		}

		$propertyId = $object->getPropertyId();

		$numericIndices = $this->getFlatArrayIndices( $propertyId );
		$lastIndex = $numericIndices[count( $numericIndices ) - 1];

		if ( $toIndex > $lastIndex + 1 || $toIndex < $numericIndices[0] ) {
			throw new OutOfBoundsException( 'Object cannot be moved to ' . $toIndex );
		}

		if ( $toIndex >= $lastIndex ) {
			$this->moveObjectToEndOfPropertyGroup( $object );
		} else {
			$this->removeObject( $object );

			$propertyGroup = array_combine(
				$this->getFlatArrayIndices( $propertyId ),
				$this->getByPropertyId( $propertyId )
			);

			$insertBefore = $propertyGroup[$toIndex];
			$this->insertObjectAtIndex( $object, $this->getFlatArrayIndexOfObject( $insertBefore ) );

		}
	}

	/**
	 * Moves an object to the end of its "property group".
	 *
	 * @param PropertyIdProvider $object
	 */
	private function moveObjectToEndOfPropertyGroup( $object ) {
		$this->removeObject( $object );

		$propertyId = $object->getPropertyId();
		$propertyIdSerialization = $propertyId->getSerialization();

		$propertyGroup = in_array( $propertyIdSerialization, $this->getPropertyIds() )
			? $this->getByPropertyId( $propertyId )
			: array();

		$propertyGroup[] = $object;
		$this->byId[$propertyIdSerialization] = $propertyGroup;

		$this->exchangeArray( $this->toFlatArray() );
	}

	/**
	 * Removes an object from the array structures.
	 *
	 * @param PropertyIdProvider $object
	 */
	private function removeObject( $object ) {
		$flatArray = $this->toFlatArray();
		$this->exchangeArray( $flatArray );
		$this->offsetUnset( array_search( $object, $flatArray ) );
		$this->buildIndex();
	}

	/**
	 * Inserts an object at a specific index.
	 *
	 * @param PropertyIdProvider $object
	 * @param int $index Absolute index within the flat list of objects.
	 */
	private function insertObjectAtIndex( $object, $index ) {
		$flatArray = $this->toFlatArray();

		$this->exchangeArray( array_merge(
			array_slice( $flatArray, 0, $index ),
			array( $object ),
			array_slice( $flatArray, $index )
		) );

		$this->buildIndex();
	}

	/**
	 * @param PropertyId $propertyId
	 * @param int $toIndex
	 */
	private function movePropertyGroup( PropertyId $propertyId, $toIndex ) {
		if ( $this->getPropertyGroupIndex( $propertyId ) === $toIndex ) {
			return;
		}

		$insertBefore = null;

		$oldIndex = $this->getPropertyGroupIndex( $propertyId );
		$byIdClone = $this->byId;

		// Remove "property group" to calculate the groups new index:
		unset( $this->byId[$propertyId->getSerialization()] );

		if ( $toIndex > $oldIndex ) {
			// If the group shall be moved towards the bottom, the number of objects within the
			// group needs to be subtracted from the absolute toIndex:
			$toIndex -= count( $byIdClone[$propertyId->getSerialization()] );
		}

		foreach ( $this->getPropertyIds() as $pId ) {
			// Accepting other than the exact index by using <= letting the "property group" "latch"
			// in the next slot.
			if ( $toIndex <= $this->getPropertyGroupIndex( $pId ) ) {
				$insertBefore = $pId;
				break;
			}
		}

		$serializedPropertyId = $propertyId->getSerialization();
		$this->byId = array();

		foreach ( $byIdClone as $serializedPId => $objects ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$pId = new PropertyId( $serializedPId );
			if ( $pId->equals( $propertyId ) ) {
				continue;
			} elseif ( $pId->equals( $insertBefore ) ) {
				$this->byId[$serializedPropertyId] = $byIdClone[$serializedPropertyId];
			}
			$this->byId[$serializedPId] = $objects;
		}

		if ( $insertBefore === null ) {
			$this->byId[$serializedPropertyId] = $byIdClone[$serializedPropertyId];
		}

		$this->exchangeArray( $this->toFlatArray() );
	}

	/**
	 * Returns the index of a "property group" (the first object in the flat array that features
	 * the specified property). Returns false if property id could not be found.
	 *
	 * @param PropertyId $propertyId
	 *
	 * @return bool|int
	 */
	private function getPropertyGroupIndex( PropertyId $propertyId ) {
		$i = 0;

		foreach ( $this->byId as $serializedPropertyId => $objects ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$pId = new PropertyId( $serializedPropertyId );
			if ( $pId->equals( $propertyId ) ) {
				return $i;
			}
			$i += count( $objects );
		}

		return false;
	}

	/**
	 * Moves an existing object to a new index. Specifying an index outside the object's "property
	 * group" will move the object to the edge of the "property group" and shift the whole group
	 * to achieve the designated index for the object to move.
	 * @since 0.5
	 *
	 * @param PropertyIdProvider $object
	 * @param int $toIndex Absolute index where to move the object to.
	 *
	 * @throws OutOfBoundsException
	 * @throws RuntimeException
	 */
	public function moveObjectToIndex( $object, $toIndex ) {
		$this->assertIndexIsBuild();

		if ( !in_array( $object, $this->toFlatArray() ) ) {
			throw new OutOfBoundsException( 'Object not present in array' );
		} elseif ( $toIndex < 0 || $toIndex > count( $this ) ) {
			throw new OutOfBoundsException( 'Specified index is out of bounds' );
		} elseif ( $this->getFlatArrayIndexOfObject( $object ) === $toIndex ) {
			return;
		}

		// Determine whether to simply reindex the object within its "property group":
		$propertyIndices = $this->getFlatArrayIndices( $object->getPropertyId() );

		if ( in_array( $toIndex, $propertyIndices ) ) {
			$this->moveObjectInPropertyGroup( $object, $toIndex );
		} else {
			$edgeIndex = ( $toIndex <= $propertyIndices[0] )
				? $propertyIndices[0]
				: $propertyIndices[count( $propertyIndices ) - 1];

			$this->moveObjectInPropertyGroup( $object, $edgeIndex );
			$this->movePropertyGroup( $object->getPropertyId(), $toIndex );
		}

		$this->exchangeArray( $this->toFlatArray() );
	}

	/**
	 * Adds an object at a specific index. If no index is specified, the object will be append to
	 * the end of its "property group" or - if no objects featuring the same property exist - to the
	 * absolute end of the array.
	 * Specifying an index outside a "property group" will place the new object at the specified
	 * index with the existing "property group" objects being shifted towards the new object.
	 *
	 * @since 0.5
	 *
	 * @param PropertyIdProvider $object
	 * @param int|null $index Absolute index where to place the new object.
	 *
	 * @throws RuntimeException
	 */
	public function addObjectAtIndex( $object, $index = null ) {
		$this->assertIndexIsBuild();

		$propertyId = $object->getPropertyId();
		$validIndices = $this->getFlatArrayIndices( $propertyId );

		if ( count( $this ) === 0 ) {
			// Array is empty, just append object.
			$this->append( $object );
		} elseif ( empty( $validIndices ) ) {
			// No objects featuring that property exist. The object may be inserted at a place
			// between existing "property groups".
			$this->append( $object );
			if ( $index !== null ) {
				$this->buildIndex();
				$this->moveObjectToIndex( $object, $index );
			}
		} else {
			// Objects featuring the same property as the object which is about to be added already
			// exist in the array.
			$this->addObjectToPropertyGroup( $object, $index );
		}

		$this->buildIndex();
	}

	/**
	 * Adds an object to an existing property group at the specified absolute index.
	 *
	 * @param PropertyIdProvider $object
	 * @param int|null $index
	 *
	 * @throws OutOfBoundsException
	 */
	private function addObjectToPropertyGroup( $object, $index = null ) {
		$propertyId = $object->getPropertyId();
		$validIndices = $this->getFlatArrayIndices( $propertyId );

		if ( empty( $validIndices ) ) {
			throw new OutOfBoundsException( 'No objects featuring the object\'s property exist' );
		}

		// Add index to allow placing object after the last object of the "property group":
		$validIndices[] = $validIndices[count( $validIndices ) - 1] + 1;

		if ( $index === null ) {
			// If index is null, append object to "property group".
			$index = $validIndices[count( $validIndices ) - 1];
		}

		if ( in_array( $index, $validIndices ) ) {
			// Add object at index within "property group".
			$this->byId[$propertyId->getSerialization()][] = $object;
			$this->exchangeArray( $this->toFlatArray() );
			$this->moveObjectToIndex( $object, $index );

		} else {
			// Index is out of the "property group"; The whole group needs to be moved.
			$this->movePropertyGroup( $propertyId, $index );

			// Move new object to the edge of the "property group" to receive its designated
			// index:
			if ( $index < $validIndices[0] ) {
				array_unshift( $this->byId[$propertyId->getSerialization()], $object );
			} else {
				$this->byId[$propertyId->getSerialization()][] = $object;
			}
		}

		$this->exchangeArray( $this->toFlatArray() );
	}

}


1		<?php
2
3		namespace Wikibase\DataModel;
4
5		use ArrayObject;
6		use OutOfBoundsException;
7		use RuntimeException;
8		use Traversable;
9		use Wikibase\DataModel\Entity\PropertyId;
10
11		/**
12		* Helper for managing objects indexed by property id.
13		*
14		* This is a light weight alternative approach to using something
15		* like GenericArrayObject with the advantages that no extra interface
16		* is needed and that indexing does not happen automatically.
17		*
18		* Lack of automatic indexing means that you will need to call the
19		* buildIndex method before doing any look-ups.
20		*
21		* Since no extra interface is used, the user is responsible for only
22		* adding objects that have a getPropertyId method that returns either
23		* a string or integer when called with no arguments.
24		*
25		* Objects may be added or moved within the structure. Absolute indices (indices according to the
26		* flat list of objects) may be specified to add or move objects. These management operations take
27		* the property grouping into account. Adding or moving objects outside their "property groups"
28		* shifts the whole group towards that index.
29		*
30		* Example of moving an object within its "property group":
31		* o1 (p1) o1 (p1)
32		* o2 (p2) /-> o3 (p2)
33		* o3 (p2) ---> move to index 1 -/ o2 (p2)
34		*
35		* Example of moving an object that triggers moving the whole "property group":
36		* o1 (p1) /-> o3 (p2)
37		* o2 (p2) \| o2 (p2)
38		* o3 (p2) ---> move to index 0 -/ o1 (p1)
39		*
40		* @since 0.2
41		* @deprecated since 5.0, use a DataModel Service instead
42		*
43		* @license GPL-2.0+
44		* @author H. Snater < [email protected] >
45		*/
46		class ByPropertyIdArray extends ArrayObject {
47
48		/**
49		* @var array[]\|null
50		*/
51		private $byId = null;
52
53		/**
54		* @see ArrayObject::__construct
55		*
56	65	* @param PropertyIdProvider[]\|Traversable\|null $input
57	65	*/
58	65	public function __construct( $input = null ) {
59		parent::__construct( (array)$input );
60		}
61
62		/**
63		* Builds the index for doing look-ups by property id.
64		*
65	62	* @since 0.2
66	62	*/
67		public function buildIndex() {
68	62	$this->byId = array();
69	61
70		/** @var PropertyIdProvider $object */
71	61	foreach ( $this as $object ) {
72	61	$propertyId = $object->getPropertyId()->getSerialization();
73	61
74		if ( !array_key_exists( $propertyId, $this->byId ) ) {
75	61	$this->byId[$propertyId] = array();
76	62	}
77	62
78		$this->byId[$propertyId][] = $object;
79		}
80		}
81
82		/**
83		* Checks whether id indexed array has been generated.
84	64	*
85	64	* @throws RuntimeException
86	2	*/
87		private function assertIndexIsBuild() {
88	62	if ( $this->byId === null ) {
89		throw new RuntimeException( 'Index not build, call buildIndex first' );
90		}
91		}
92
93		/**
94		* Returns the property ids used for indexing.
95		*
96		* @since 0.2
97		*
98	38	* @return PropertyId[]
99	38	* @throws RuntimeException
100		*/
101	37	public function getPropertyIds() {
102	37	$this->assertIndexIsBuild();
103	37
104	37	return array_map(
105	37	function( $serializedPropertyId ) {
106	37	return new PropertyId( $serializedPropertyId );
107		},
108		array_keys( $this->byId )
109		);
110		}
111
112		/**
113		* Returns the objects featuring the provided property id in the index.
114		*
115		* @since 0.2
116		*
117		* @param PropertyId $propertyId
118		*
119		* @throws OutOfBoundsException
120	27	* @throws RuntimeException
121	27	* @return PropertyIdProvider[]
122		*/
123	26	public function getByPropertyId( PropertyId $propertyId ) {
124	1	$this->assertIndexIsBuild();
125
126		if ( !( array_key_exists( $propertyId->getSerialization(), $this->byId ) ) ) {
127	25	throw new OutOfBoundsException( "Object with propertyId \"$propertyId\" not found" );
128		}
129
130		return $this->byId[$propertyId->getSerialization()];
131		}
132
133		/**
134		* Returns the absolute index of an object or false if the object could not be found.
135		* @since 0.5
136		*
137		* @param PropertyIdProvider $object
138		*
139	47	* @return bool\|int
140	47	* @throws RuntimeException
141		*/
142	47	public function getFlatArrayIndexOfObject( $object ) {
143	47	$this->assertIndexIsBuild();
144	47
145	47	$i = 0;
146		foreach ( $this as $o ) {
147	40	if ( $o === $object ) {
148	40	return $i;
149		}
150		$i++;
151		}
152		return false;
153		}
154
155		/**
156		* Returns the objects in a flat array (using the indexed form for generating the array).
157		* @since 0.5
158		*
159		* @return PropertyIdProvider[]
160	55	* @throws RuntimeException
161	55	*/
162		public function toFlatArray() {
163	55	$this->assertIndexIsBuild();
164	55
165	55	$array = array();
166	55	foreach ( $this->byId as $objects ) {
		0 ignored issues – show Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report The expression `$this->byId` of type `array<integer,array>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
167	55	$array = array_merge( $array, $objects );
168		}
169		return $array;
170		}
171
172		/**
173		* Returns the absolute numeric indices of objects featuring the same property id.
174		*
175		* @param PropertyId $propertyId
176		*
177		* @throws RuntimeException
178	43	* @return int[]
179	43	*/
180		private function getFlatArrayIndices( PropertyId $propertyId ) {
181	43	$this->assertIndexIsBuild();
182	43
183		$propertyIndices = array();
184	43	$i = 0;
185	41
186	41	foreach ( $this->byId as $serializedPropertyId => $objects ) {
		0 ignored issues – show Bug introduced 2015-12-14 10:23 UTC by Report Bug Copy Issue Report The expression `$this->byId` of type `array<integer,array>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
187	41	if ( $serializedPropertyId === $propertyId->getSerialization() ) {
188		$propertyIndices = range( $i, $i + count( $objects ) - 1 );
189	29	break;
190		} else {
191	43	$i += count( $objects );
192		}
193	43	}
194
195		return $propertyIndices;
196		}
197
198		/**
199		* Moves an object within its "property group".
200		*
201		* @param PropertyIdProvider $object
202		* @param int $toIndex Absolute index within a "property group".
203		*
204	38	* @throws OutOfBoundsException
205	38	*/
206		private function moveObjectInPropertyGroup( $object, $toIndex ) {
207	38	$currentIndex = $this->getFlatArrayIndexOfObject( $object );
208	17
209		if ( $toIndex === $currentIndex ) {
210		return;
211	21	}
212
213	21	$propertyId = $object->getPropertyId();
214	21
215		$numericIndices = $this->getFlatArrayIndices( $propertyId );
216	21	$lastIndex = $numericIndices[count( $numericIndices ) - 1];
217
218		if ( $toIndex > $lastIndex + 1 \|\| $toIndex < $numericIndices[0] ) {
219		throw new OutOfBoundsException( 'Object cannot be moved to ' . $toIndex );
220	21	}
221	12
222	12	if ( $toIndex >= $lastIndex ) {
223	9	$this->moveObjectToEndOfPropertyGroup( $object );
224		} else {
225	9	$this->removeObject( $object );
226	9
227	9	$propertyGroup = array_combine(
228	9	$this->getFlatArrayIndices( $propertyId ),
229		$this->getByPropertyId( $propertyId )
230	9	);
231	9
232		$insertBefore = $propertyGroup[$toIndex];
233	21	$this->insertObjectAtIndex( $object, $this->getFlatArrayIndexOfObject( $insertBefore ) );
		0 ignored issues – show Security Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report It seems like `$this->getFlatArrayIndexOfObject($insertBefore)` targeting `Wikibase\DataModel\ByPro...latArrayIndexOfObject()` can also be of type `false`; however, `Wikibase\DataModel\ByPro...::insertObjectAtIndex()` does only seem to accept `integer`, did you maybe forget to handle an error condition? Loading history...
234		}
235		}
236
237		/**
238		* Moves an object to the end of its "property group".
239		*
240	12	* @param PropertyIdProvider $object
241	12	*/
242		private function moveObjectToEndOfPropertyGroup( $object ) {
243		$this->removeObject( $object );
244	12
245	12	$propertyId = $object->getPropertyId();
246		$propertyIdSerialization = $propertyId->getSerialization();
247	12
248	12	$propertyGroup = in_array( $propertyIdSerialization, $this->getPropertyIds() )
249	12	? $this->getByPropertyId( $propertyId )
250		: array();
251	12
252	12	$propertyGroup[] = $object;
253		$this->byId[$propertyIdSerialization] = $propertyGroup;
254	12
255	12	$this->exchangeArray( $this->toFlatArray() );
256		}
257
258		/**
259		* Removes an object from the array structures.
260		*
261		* @param PropertyIdProvider $object
262	23	*/
263	23	private function removeObject( $object ) {
264	23	$flatArray = $this->toFlatArray();
265	23	$this->exchangeArray( $flatArray );
266	23	$this->offsetUnset( array_search( $object, $flatArray ) );
267	23	$this->buildIndex();
268		}
269
270		/**
271		* Inserts an object at a specific index.
272		*
273		* @param PropertyIdProvider $object
274		* @param int $index Absolute index within the flat list of objects.
275	9	*/
276	9	private function insertObjectAtIndex( $object, $index ) {
277		$flatArray = $this->toFlatArray();
278	9
279	9	$this->exchangeArray( array_merge(
280	9	array_slice( $flatArray, 0, $index ),
281	9	array( $object ),
282	9	array_slice( $flatArray, $index )
283		) );
284	9
285	9	$this->buildIndex();
286		}
287
288		/**
289		* @param PropertyId $propertyId
290		* @param int $toIndex
291	32	*/
292	32	private function movePropertyGroup( PropertyId $propertyId, $toIndex ) {
293		if ( $this->getPropertyGroupIndex( $propertyId ) === $toIndex ) {
294		return;
295		}
296	32
297		$insertBefore = null;
298	32
299	32	$oldIndex = $this->getPropertyGroupIndex( $propertyId );
300		$byIdClone = $this->byId;
301
302	32	// Remove "property group" to calculate the groups new index:
303		unset( $this->byId[$propertyId->getSerialization()] );
304	32
305		if ( $toIndex > $oldIndex ) {
306		// If the group shall be moved towards the bottom, the number of objects within the
307	17	// group needs to be subtracted from the absolute toIndex:
308	17	$toIndex -= count( $byIdClone[$propertyId->getSerialization()] );
309		}
310	32
311		foreach ( $this->getPropertyIds() as $pId ) {
312		// Accepting other than the exact index by using <= letting the "property group" "latch"
313	32	// in the next slot.
314	24	if ( $toIndex <= $this->getPropertyGroupIndex( $pId ) ) {
315	24	$insertBefore = $pId;
316		break;
317	32	}
318		}
319	32
320	32	$serializedPropertyId = $propertyId->getSerialization();
321		$this->byId = array();
322	32
323	32	foreach ( $byIdClone as $serializedPId => $objects ) {
		0 ignored issues – show Bug introduced 2015-11-27 17:36 UTC by Report Bug Copy Issue Report The expression `$byIdClone` of type `array<integer,array>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
324	32	$pId = new PropertyId( $serializedPId );
325	32	if ( $pId->equals( $propertyId ) ) {
326	32	continue;
327	24	} elseif ( $pId->equals( $insertBefore ) ) {
328	24	$this->byId[$serializedPropertyId] = $byIdClone[$serializedPropertyId];
329	32	}
330	32	$this->byId[$serializedPId] = $objects;
331		}
332	32
333	8	if ( $insertBefore === null ) {
334	8	$this->byId[$serializedPropertyId] = $byIdClone[$serializedPropertyId];
335		}
336	32
337	32	$this->exchangeArray( $this->toFlatArray() );
338		}
339
340		/**
341		* Returns the index of a "property group" (the first object in the flat array that features
342		* the specified property). Returns false if property id could not be found.
343		*
344		* @param PropertyId $propertyId
345		*
346		* @return bool\|int
347	32	*/
348	32	private function getPropertyGroupIndex( PropertyId $propertyId ) {
349		$i = 0;
350	32
351	32	foreach ( $this->byId as $serializedPropertyId => $objects ) {
		0 ignored issues – show Bug introduced 2015-12-14 10:23 UTC by Report Bug Copy Issue Report The expression `$this->byId` of type `array<integer,array>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
352	32	$pId = new PropertyId( $serializedPropertyId );
353	32	if ( $pId->equals( $propertyId ) ) {
354		return $i;
355	30	}
356	30	$i += count( $objects );
357		}
358
359		return false;
360		}
361
362		/**
363		* Moves an existing object to a new index. Specifying an index outside the object's "property
364		* group" will move the object to the edge of the "property group" and shift the whole group
365		* to achieve the designated index for the object to move.
366		* @since 0.5
367		*
368		* @param PropertyIdProvider $object
369		* @param int $toIndex Absolute index where to move the object to.
370		*
371		* @throws OutOfBoundsException
372		* @throws RuntimeException
373	47	*/
374	47	public function moveObjectToIndex( $object, $toIndex ) {
375		$this->assertIndexIsBuild();
376	47
377	1	if ( !in_array( $object, $this->toFlatArray() ) ) {
378	46	throw new OutOfBoundsException( 'Object not present in array' );
379	1	} elseif ( $toIndex < 0 \|\| $toIndex > count( $this ) ) {
380	45	throw new OutOfBoundsException( 'Specified index is out of bounds' );
381	7	} elseif ( $this->getFlatArrayIndexOfObject( $object ) === $toIndex ) {
382		return;
383		}
384
385	38	// Determine whether to simply reindex the object within its "property group":
386		$propertyIndices = $this->getFlatArrayIndices( $object->getPropertyId() );
387	38
388	8	if ( in_array( $toIndex, $propertyIndices ) ) {
389	8	$this->moveObjectInPropertyGroup( $object, $toIndex );
390	30	} else {
391	30	$edgeIndex = ( $toIndex <= $propertyIndices[0] )
392	30	? $propertyIndices[0]
393		: $propertyIndices[count( $propertyIndices ) - 1];
394	30
395	30	$this->moveObjectInPropertyGroup( $object, $edgeIndex );
396		$this->movePropertyGroup( $object->getPropertyId(), $toIndex );
397		}
398	38
399	38	$this->exchangeArray( $this->toFlatArray() );
400		}
401
402		/**
403		* Adds an object at a specific index. If no index is specified, the object will be append to
404		* the end of its "property group" or - if no objects featuring the same property exist - to the
405		* absolute end of the array.
406		* Specifying an index outside a "property group" will place the new object at the specified
407		* index with the existing "property group" objects being shifted towards the new object.
408		*
409		* @since 0.5
410		*
411		* @param PropertyIdProvider $object
412		* @param int\|null $index Absolute index where to place the new object.
413		*
414	7	* @throws RuntimeException
415	7	*/
416		public function addObjectAtIndex( $object, $index = null ) {
417	7	$this->assertIndexIsBuild();
418	7
419		$propertyId = $object->getPropertyId();
420	7	$validIndices = $this->getFlatArrayIndices( $propertyId );
421
422	2	if ( count( $this ) === 0 ) {
423	7	// Array is empty, just append object.
424		$this->append( $object );
425		} elseif ( empty( $validIndices ) ) {
426	2	// No objects featuring that property exist. The object may be inserted at a place
427	2	// between existing "property groups".
428	2	$this->append( $object );
429	2	if ( $index !== null ) {
430	2	$this->buildIndex();
431	2	$this->moveObjectToIndex( $object, $index );
432		}
433		} else {
434	3	// Objects featuring the same property as the object which is about to be added already
435		// exist in the array.
436		$this->addObjectToPropertyGroup( $object, $index );
437	7	}
438	7
439		$this->buildIndex();
440		}
441
442		/**
443		* Adds an object to an existing property group at the specified absolute index.
444		*
445		* @param PropertyIdProvider $object
446		* @param int\|null $index
447		*
448	3	* @throws OutOfBoundsException
449		*/
450	3	private function addObjectToPropertyGroup( $object, $index = null ) {
451	3	$propertyId = $object->getPropertyId();
452		$validIndices = $this->getFlatArrayIndices( $propertyId );
453	3
454		if ( empty( $validIndices ) ) {
455		throw new OutOfBoundsException( 'No objects featuring the object\'s property exist' );
456		}
457
458	3	// Add index to allow placing object after the last object of the "property group":
459		$validIndices[] = $validIndices[count( $validIndices ) - 1] + 1;
460	3
461		if ( $index === null ) {
462	1	// If index is null, append object to "property group".
463	1	$index = $validIndices[count( $validIndices ) - 1];
464		}
465	3
466		if ( in_array( $index, $validIndices ) ) {
467	1	// Add object at index within "property group".
468	1	$this->byId[$propertyId->getSerialization()][] = $object;
469	1	$this->exchangeArray( $this->toFlatArray() );
470		$this->moveObjectToIndex( $object, $index );
471	1
472		} else {
473	2	// Index is out of the "property group"; The whole group needs to be moved.
474		$this->movePropertyGroup( $propertyId, $index );
475
476		// Move new object to the edge of the "property group" to receive its designated
477	2	// index:
478	2	if ( $index < $validIndices[0] ) {
479	2	array_unshift( $this->byId[$propertyId->getSerialization()], $object );
480		} else {
481		$this->byId[$propertyId->getSerialization()][] = $object;
482		}
483		}
484	3
485	3	$this->exchangeArray( $this->toFlatArray() );
486		}
487
488		}
489

wmde / WikibaseDataModel

Pull Request — master (#666)

ByPropertyIdArray::getPropertyGroupIndex() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like