Merge branch 'master' of github.com:wmde/WikibaseDataModel

Author: JeroenDeDauw

Aliases.php

@@ -61,12 +61,7 @@ abstract class HashArray extends \Wikibase\DataModel\HashArray {}
 	/**
 	 * @deprecated since 0.6, use the base class instead.
 	 */
-	interface MapHasher extends \Wikibase\DataModel\MapHasher {}
-
-	/**
-	 * @deprecated since 0.6, use the base class instead.
-	 */
-	class MapValueHasher extends \Wikibase\DataModel\MapValueHasher {}
+	interface MapHasher extends DataModel\Internal\MapHasher {}
 
 	/**
 	 * @deprecated since 0.6, use the base class instead.

RELEASE-NOTES.md

@@ -48,6 +48,8 @@ Other breaking changes:
 * `SiteLinkList::addNewSiteLink` no longer returns a `SiteLinkList` instance
 * Removed the global variable `evilDataValueMap`
 * Removed `ClaimAggregate` interface, which is thus no longer implemented by `Entity`
+* `HashableObjectStorage::getValueHash` no longer accepts a first optional parameter
+* `MapHasher` and `MapValueHasher` are now package private
 
 #### Additions
 

WikibaseDataModel.php

@@ -32,8 +32,7 @@ class_alias( 'Wikibase\DataModel\References', 'Wikibase\References' );
 class_alias( 'Wikibase\DataModel\ReferenceList', 'Wikibase\ReferenceList' );
 class_alias( 'Wikibase\DataModel\HashableObjectStorage', 'Wikibase\HashableObjectStorage' );
 class_alias( 'Wikibase\DataModel\HashArray', 'Wikibase\HashArray' );
-class_alias( 'Wikibase\DataModel\MapHasher', 'Wikibase\MapHasher' );
-class_alias( 'Wikibase\DataModel\MapValueHasher', 'Wikibase\MapValueHasher' );
+class_alias( 'Wikibase\DataModel\Internal\MapHasher', 'Wikibase\MapHasher' );
 class_alias( 'Wikibase\DataModel\ByPropertyIdArray', 'Wikibase\ByPropertyIdArray' );
 class_alias( 'Wikibase\DataModel\Claim\Claim', 'Wikibase\Claim' );
 class_alias( 'Wikibase\DataModel\Claim\ClaimListAccess', 'Wikibase\ClaimListAccess' );

src/Entity/EntityId.php

@@ -110,9 +110,8 @@ public function __toString() {
 	 * @return boolean
 	 */
 	public function equals( $target ) {
-		return $target instanceof EntityId
-			&& $target->getSerialization() === $this->serialization
-			&& $target->getEntityType() === $this->entityType;
+		return $target instanceof self
+			&& $target->serialization === $this->serialization;
 	}
 
 	/**

src/Entity/Item.php

@@ -333,8 +333,6 @@ public function addClaim( Claim $claim ) {
 			throw new InvalidArgumentException( 'Can\'t add a Claim without a GUID.' );
 		}
 
-		// TODO: ensure guid is valid for entity
-
 		$this->statements[] = $claim;
 	}
 
@@ -357,8 +355,6 @@ public function getClaims() {
 	}
 
 	/**
-	 * TODO: change to take Claim[]
-	 *
 	 * @since 0.4
 	 *
 	 * @param Claims $claims

src/HashArray.php

@@ -4,6 +4,7 @@
 
 use Hashable;
 use InvalidArgumentException;
+use Wikibase\DataModel\Internal\MapValueHasher;
 
 /**
  * Generic array object with lookups based on hashes of the elements.
@@ -205,8 +206,6 @@ public function removeByElementHash( $elementHash ) {
 	 * @return boolean Indicates if the element was added or not.
 	 */
 	public function addElement( Hashable $element ) {
-		// TODO: this duplicates logic of preSetElement
-		// Probably best update setElement in GenericArrayObject to return boolean it got from preSetElement
 		$append = $this->acceptDuplicates || !$this->hasElementHash( $element->getHash() );
 
 		if ( $append ) {
@@ -282,8 +281,6 @@ function( $value ) use ( $index ) {
 	 *
 	 * @since 0.1
 	 *
-	 * @internal param MapHasher $mapHasher
-	 *
 	 * @return string
 	 */
 	public function getHash() {

src/HashableObjectStorage.php

@@ -3,6 +3,7 @@
 namespace Wikibase\DataModel;
 
 use Hashable;
+use Wikibase\DataModel\Internal\MapValueHasher;
 
 /**
  * Object storage for Hashable objects.
@@ -58,25 +59,12 @@ public function removeDuplicates() {
 	/**
 	 * The hash is purely valuer based. Order of the elements in the array is not held into account.
 	 *
-	 * Note: we cannot implement Hashable interface by having this be getHash since PHP 5.4
-	 * introduced a similarly named method in SplObjectStorage.
-	 *
 	 * @since 0.3
 	 *
-	 * @internal param MapHasher $mapHasher
-	 *
 	 * @return string
 	 */
 	public function getValueHash() {
-		// We cannot have this as optional arg, because then we're no longer
-		// implementing the Hashable interface properly according to PHP...
-		$args = func_get_args();
-
-		/**
-		 * @var MapHasher $hasher
-		 */
-		$hasher = array_key_exists( 0, $args ) ? $args[0] : new MapValueHasher();
-
+		$hasher = new MapValueHasher();
 		return $hasher->hash( $this );
 	}
 

src/MapHasher.php src/Internal/MapHasher.phpsrc/MapHasher.php renamed to src/Internal/MapHasher.php

@@ -1,15 +1,13 @@
 <?php
 
-namespace Wikibase\DataModel;
+namespace Wikibase\DataModel\Internal;
 
 use Traversable;
 
 /**
  * Interface for objects that can hash a map (ie associative array).
  * Elements must implement Hashable.
  *
- * TODO: might want to make this internal to DataModel.
- *
  * @licence GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */

src/MapValueHasher.php src/Internal/MapValueHasher.phpsrc/MapValueHasher.php renamed to src/Internal/MapValueHasher.php

@@ -1,10 +1,11 @@
 <?php
 
-namespace Wikibase\DataModel;
+namespace Wikibase\DataModel\Internal;
 
 use Hashable;
 use InvalidArgumentException;
 use Traversable;
+use Wikibase\DataModel\Internal\MapHasher;
 
 /**
  * Generates hashes for associative arrays based on the values of their elements.

src/Reference.php

@@ -83,9 +83,8 @@ public function getHash() {
 	 * @return boolean
 	 */
 	public function equals( $mixed ) {
-		return is_object( $mixed )
-			&& $mixed instanceof Reference
-			&& $this->getSnaks()->equals( $mixed->getSnaks() );
+		return $mixed instanceof self
+			&& $this->snaks->equals( $mixed->snaks );
 	}
 
 }