Merge pull request #496 from wmde/settersAreSetters

Do not return anything from Entity setters

Author: addshore

RELEASE-NOTES.md

@@ -38,11 +38,12 @@ Other breaking changes:
 * Removed previously deprecated `Property::newEmpty`, use `Property::newFromType` or `new Property()` instead
 * Renamed `StatementList::getWithPropertyId` to `StatementList::getByPropertyId`
 * Renamed `StatementList::getWithRank` to `StatementList::getByRank`
-* `Reference` and `ReferenceList`s no longer can not be instantiated with `null`
-* Added `setId` method to `EntityDocument`
+* `Entity::setLabel` and `Entity::setDescription` no longer return anything
+* `Reference` and `ReferenceList`s no longer can be instantiated with `null`
 
 #### Additions
 
+* Added `EntityDocument::setId`
 * Added `StatementByGuidMap`
 * Added `StatementListHolder`
 * Added `StatementList::getFirstStatementWithGuid`

src/Entity/Entity.php

@@ -54,12 +54,9 @@ public function getId() {
 	 *
 	 * @param string $languageCode
 	 * @param string $value
-	 *
-	 * @return string
 	 */
 	public function setLabel( $languageCode, $value ) {
 		$this->fingerprint->setLabel( $languageCode, $value );
-		return $value;
 	}
 
 	/**
@@ -69,12 +66,9 @@ public function setLabel( $languageCode, $value ) {
 	 *
 	 * @param string $languageCode
 	 * @param string $value
-	 *
-	 * @return string
 	 */
 	public function setDescription( $languageCode, $value ) {
 		$this->fingerprint->setDescription( $languageCode, $value );
-		return $value;
 	}
 
 	/**

tests/unit/Entity/ItemIdSetTest.php

@@ -91,14 +91,14 @@ public function testGivenDuplicates_noLongerPresentInIteration() {
 	}
 
 	/**
-	 * @dataProvider setProvider
+	 * @dataProvider itemIdSetProvider
 	 */
 	public function testGivenTheSameSet_equalsReturnsTrue( ItemIdSet $set ) {
 		$this->assertTrue( $set->equals( $set ) );
 		$this->assertTrue( $set->equals( clone $set ) );
 	}
 
-	public function setProvider() {
+	public function itemIdSetProvider() {
 		return array(
 			array(
 				new ItemIdSet(),