Merge pull request #656 from wmde/release60

Release 6.0.0

Author: Benestar

README.md

@@ -30,12 +30,12 @@ the git repository and take care of loading yourself.
 To add this package as a local, per-project dependency to your project, simply add a
 dependency on `wikibase/data-model` to your project's `composer.json` file.
 Here is a minimal example of a `composer.json` file that just defines a dependency on
-Wikibase DataModel 5.x:
+Wikibase DataModel 6.x:
 
 ```js
 {
     "require": {
-        "wikibase/data-model": "~5.0"
+        "wikibase/data-model": "~6.0"
     }
 }
 ```

RELEASE-NOTES.md

@@ -1,8 +1,12 @@
 # Wikibase DataModel release notes
 
-## Version 6.0.0 (dev)
+## Version 6.0.0 (2016-03-10)
+
+This release removes the long deprecated Entity base class in favor of much more narrow interfaces.
 
 * Removed `Entity` class (deprecated since 1.0)
+* `StatementListProvider`, `LabelsProvider`, `DescriptionsProvider`, `AliasesProvider` and
+  `FingerprintProvider` now give the guarantee to return objects by reference
 * `Item` and `Property` no longer extend `Entity`
     * Removed `getLabel`, `getDescription`, `getAliases`, `getAllAliases`,
       `setLabels`, `setDescriptions`, `addAliases`, `setAllAliases`,
@@ -12,7 +16,7 @@
 * `Item::getDescriptions` and `Property::getDescriptions` now return a `TermList`
 * Added `Item::getAliasGroups` and `Property::getAliasGroups`
 * `TermList` and `AliasGroupList` no longer throw an `InvalidArgumentException` for invalid language codes.
-    * `getByLangauge` now throws an `OutOfBoundsException`.
+    * `getByLangauge` throws an `OutOfBoundsException` instead.
     * `removeByLanguage` does nothing for invalid values.
     * `hasTermForLanguage` and `hasGroupForLangauge` return false instead.
 

WikibaseDataModel.php

@@ -7,7 +7,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
 
-define( 'WIKIBASE_DATAMODEL_VERSION', '5.1.0' );
+define( 'WIKIBASE_DATAMODEL_VERSION', '6.0.0' );
 
 if ( defined( 'MEDIAWIKI' ) && function_exists( 'wfLoadExtension' ) ) {
 	wfLoadExtension( 'WikibaseDataModel', __DIR__ . '/mediawiki-extension.json' );

mediawiki-extension.json

@@ -1,6 +1,6 @@
 {
 	"name": "Wikibase DataModel",
-	"version": "5.1.0",
+	"version": "6.0.0",
 	"author": [
 		"[https://www.mediawiki.org/wiki/User:Jeroen_De_Dauw Jeroen De Dauw]",
 		"Thiemo Mättig"

src/Statement/StatementListProvider.php

@@ -3,7 +3,8 @@
 namespace Wikibase\DataModel\Statement;
 
 /**
- * Interface for classes that contain a StatementList.
+ * Common interface for classes (typically Entities) that contain a StatementList. Implementations
+ * must guarantee this returns the original, mutable object by reference.
  *
  * @since 2.2.0
  *
@@ -13,6 +14,8 @@
 interface StatementListProvider {
 
 	/**
+	 * This is guaranteed to return the original, mutable object by reference.
+	 *
 	 * @return StatementList
 	 */
 	public function getStatements();

src/Term/AliasesProvider.php

@@ -3,6 +3,9 @@
 namespace Wikibase\DataModel\Term;
 
 /**
+ * Common interface for classes (typically Entities) that contain an AliasGroupList. Implementations
+ * must guarantee this returns the original, mutable object by reference.
+ *
  * @since 4.1
  *
  * @licence GNU GPL v2+
@@ -11,7 +14,7 @@
 interface AliasesProvider {
 
 	/**
-	 * It is not guaranteed that this method returns the original object.
+	 * This is guaranteed to return the original, mutable object by reference.
 	 *
 	 * @return AliasGroupList
 	 */

src/Term/DescriptionsProvider.php

@@ -3,6 +3,10 @@
 namespace Wikibase\DataModel\Term;
 
 /**
+ * Common interface for classes (typically Entities) that contain a TermList, representing
+ * descriptions. Implementations must guarantee this returns the original, mutable object by
+ * reference.
+ *
  * @since 4.1
  *
  * @licence GNU GPL v2+
@@ -11,7 +15,7 @@
 interface DescriptionsProvider {
 
 	/**
-	 * It is not guaranteed that this method returns the original object.
+	 * This is guaranteed to return the original, mutable object by reference.
 	 *
 	 * @return TermList
 	 */

src/Term/FingerprintProvider.php

@@ -3,6 +3,9 @@
 namespace Wikibase\DataModel\Term;
 
 /**
+ * Common interface for classes (typically Entities) that contain a Fingerprint. Implementations
+ * must guarantee this returns the original, mutable object by reference.
+ *
  * @since 0.7.3
  *
  * @licence GNU GPL v2+
@@ -11,6 +14,8 @@
 interface FingerprintProvider {
 
 	/**
+	 * This is guaranteed to return the original, mutable object by reference.
+	 *
 	 * @return Fingerprint
 	 */
 	public function getFingerprint();

src/Term/LabelsProvider.php

@@ -3,6 +3,9 @@
 namespace Wikibase\DataModel\Term;
 
 /**
+ * Common interface for classes (typically Entities) that contain a TermList, representing labels.
+ * Implementations must guarantee this returns the original, mutable object by reference.
+ *
  * @since 4.1
  *
  * @licence GNU GPL v2+
@@ -11,7 +14,7 @@
 interface LabelsProvider {
 
 	/**
-	 * It is not guaranteed that this method returns the original object.
+	 * This is guaranteed to return the original, mutable object by reference.
 	 *
 	 * @return TermList
 	 */