Merge pull request #615 from wmde/entitydocument-equals

Add equals to EntityDocument

Author: JeroenDeDauw

RELEASE-NOTES.md

@@ -9,6 +9,8 @@
 * Removed `ReferenceList::removeDuplicates`
 * `ReferenceList` no longer derives from `SplObjectStorage`, though still implements `Countable`
 * Removed `HashableObjectStorage`
+* Added `EntityDocument::equals`
+* `Entity` no longer implements `Comparable`
 
 #### Other changes
 

src/Entity/Entity.php

@@ -2,8 +2,6 @@
 
 namespace Wikibase\DataModel\Entity;
 
-use Comparable;
-use Wikibase\DataModel\Statement\Statement;
 use Wikibase\DataModel\Term\AliasGroup;
 use Wikibase\DataModel\Term\AliasGroupList;
 use Wikibase\DataModel\Term\FingerprintHolder;
@@ -19,7 +17,7 @@
  * @licence GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-abstract class Entity implements Comparable, FingerprintHolder, EntityDocument {
+abstract class Entity implements FingerprintHolder, EntityDocument {
 
 	/**
 	 * Sets the value for the label in a certain value.

src/Entity/EntityDocument.php

@@ -52,4 +52,16 @@ public function setId( $id );
 	 */
 	public function isEmpty();
 
+	/**
+	 * 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
+	 *
+	 * @return bool
+	 */
+	public function equals( EntityDocument $entity );
+
 }

src/Entity/Item.php

@@ -300,28 +300,23 @@ public function setStatements( StatementList $statements ) {
 	}
 
 	/**
-	 * @see Comparable::equals
-	 *
-	 * Two items 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.
+	 * @see EntityDocument::equals
 	 *
 	 * @since 0.1
 	 *
-	 * @param mixed $target
+	 * @param EntityDocument $entity
 	 *
 	 * @return bool
 	 */
-	public function equals( $target ) {
-		if ( $this === $target ) {
+	public function equals( EntityDocument $entity ) {
+		if ( $this === $entity ) {
 			return true;
 		}
 
-		return $target instanceof self
-			&& $this->fingerprint->equals( $target->fingerprint )
-			&& $this->siteLinks->equals( $target->siteLinks )
-			&& $this->statements->equals( $target->statements );
+		return $entity instanceof self
+		       && $this->fingerprint->equals( $entity->fingerprint )
+		       && $this->siteLinks->equals( $entity->siteLinks )
+		       && $this->statements->equals( $entity->statements );
 	}
 
 }

src/Entity/Property.php

@@ -190,28 +190,23 @@ public static function newFromType( $dataTypeId ) {
 	}
 
 	/**
-	 * @see Comparable::equals
-	 *
-	 * Two properties 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.
+	 * @see EntityDocument::equals
 	 *
 	 * @since 0.1
 	 *
-	 * @param mixed $target
+	 * @param EntityDocument $entity
 	 *
 	 * @return bool
 	 */
-	public function equals( $target ) {
-		if ( $this === $target ) {
+	public function equals( EntityDocument $entity ) {
+		if ( $this === $entity ) {
 			return true;
 		}
 
-		return $target instanceof self
-			&& $this->dataTypeId === $target->dataTypeId
-			&& $this->fingerprint->equals( $target->fingerprint )
-			&& $this->statements->equals( $target->statements );
+		return $entity instanceof self
+		       && $this->dataTypeId === $entity->dataTypeId
+		       && $this->fingerprint->equals( $entity->fingerprint )
+		       && $this->statements->equals( $entity->statements );
 	}
 
 	/**