Merge pull request #621 from wmde/equalsRevert

Revert unnecessary breaking change to Item::equals
Merging this for now to unblock the 5.0 release.

I still think we shouldn't use Comparable here, since it's useless without support for generics. But let's keep that discussion for the 6.0 release.

Author: Daniel Kinzler

RELEASE-NOTES.md

@@ -17,8 +17,7 @@
     * Added `getIterator` method.
 * Removed `ReferenceList::removeDuplicates`.
 * `ReferenceList::addReference` now throws an `InvalidArgumentException` for negative indices.
-* `Entity` no longer implements `Comparable`
-* Added `EntityDocument::equals`
+* `EntityDocument` now implements `Comparable`.
 
 ## Version 4.4.0 (2016-01-20)
 

src/Entity/EntityDocument.php

@@ -2,6 +2,7 @@
 
 namespace Wikibase\DataModel\Entity;
 
+use Comparable;
 use InvalidArgumentException;
 
 /**
@@ -14,7 +15,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Bene* < benestar.wikimedia@gmail.com >
  */
-interface EntityDocument {
+interface EntityDocument extends Comparable {
 
 	/**
 	 * Returns the id of the entity or null if it does not have one.
@@ -54,15 +55,17 @@ public function setId( $id );
 	public function isEmpty();
 
 	/**
+	 * @see Comparable::equals
+	 *
 	 * Two entities are considered equal if they are of the same
 	 * type and have the same value. The value does not include
 	 * the id, so entities with the same value but different id
 	 * are considered equal.
 	 *
-	 * @param EntityDocument $entity
+	 * @param mixed $target
 	 *
 	 * @return bool
 	 */
-	public function equals( EntityDocument $entity );
+	public function equals( $target );
 
 }

src/Entity/Item.php

@@ -304,19 +304,19 @@ public function setStatements( StatementList $statements ) {
 	 *
 	 * @since 0.1
 	 *
-	 * @param EntityDocument $entity
+	 * @param mixed $target
 	 *
 	 * @return bool
 	 */
-	public function equals( EntityDocument $entity ) {
-		if ( $this === $entity ) {
+	public function equals( $target ) {
+		if ( $this === $target ) {
 			return true;
 		}
 
-		return $entity instanceof self
-		       && $this->fingerprint->equals( $entity->fingerprint )
-		       && $this->siteLinks->equals( $entity->siteLinks )
-		       && $this->statements->equals( $entity->statements );
+		return $target instanceof self
+			&& $this->fingerprint->equals( $target->fingerprint )
+			&& $this->siteLinks->equals( $target->siteLinks )
+			&& $this->statements->equals( $target->statements );
 	}
 
 }

src/Entity/Property.php

@@ -194,19 +194,19 @@ public static function newFromType( $dataTypeId ) {
 	 *
 	 * @since 0.1
 	 *
-	 * @param EntityDocument $entity
+	 * @param mixed $target
 	 *
 	 * @return bool
 	 */
-	public function equals( EntityDocument $entity ) {
-		if ( $this === $entity ) {
+	public function equals( $target ) {
+		if ( $this === $target ) {
 			return true;
 		}
 
-		return $entity instanceof self
-		       && $this->dataTypeId === $entity->dataTypeId
-		       && $this->fingerprint->equals( $entity->fingerprint )
-		       && $this->statements->equals( $entity->statements );
+		return $target instanceof self
+			&& $this->dataTypeId === $target->dataTypeId
+			&& $this->fingerprint->equals( $target->fingerprint )
+			&& $this->statements->equals( $target->statements );
 	}
 
 	/**