Remove Snaks interface

Author: thiemowmde

RELEASE-NOTES.md

@@ -32,6 +32,7 @@ Phasing out of `Claims`:
 
 Other breaking changes:
 
+* Removed `Snaks` interface, use `SnakList` instead
 * Removed previously deprecated `Entity::getAllSnaks`, use `StatementList::getAllSnaks` instead
 * Removed previously deprecated `EntityId::getPrefixedId`, use `EntityId::getSerialization` instead
 * `Reference` and `ReferenceList`s no longer can not be instantiated with `null`

src/Reference.php

@@ -5,7 +5,6 @@
 use InvalidArgumentException;
 use Wikibase\DataModel\Snak\Snak;
 use Wikibase\DataModel\Snak\SnakList;
-use Wikibase\DataModel\Snak\Snaks;
 
 /**
  * Object that represents a single Wikibase reference.
@@ -19,23 +18,23 @@
 class Reference implements \Hashable, \Comparable, \Immutable, \Countable {
 
 	/**
-	 * @var Snaks
+	 * @var SnakList
 	 */
 	private $snaks;
 
 	/**
 	 * An array of Snak objects is only supported since version 1.1.
 	 *
-	 * @param Snak[]|Snaks $snaks
+	 * @param Snak[]|SnakList $snaks
 	 * @throws InvalidArgumentException
 	 */
 	public function __construct( $snaks = array() ) {
 		if ( is_array( $snaks ) ) {
 			$snaks = new SnakList( $snaks );
 		}
 
-		if ( !( $snaks instanceof Snaks ) ) {
-			throw new InvalidArgumentException( '$snaks must be an array or an instance of Snaks' );
+		if ( !( $snaks instanceof SnakList ) ) {
+			throw new InvalidArgumentException( '$snaks must be an array or an instance of SnakList' );
 		}
 
 		$this->snaks = $snaks;
@@ -47,7 +46,7 @@ public function __construct( $snaks = array() ) {
 	 *
 	 * @since 0.1
 	 *
-	 * @return Snaks
+	 * @return SnakList
 	 */
 	public function getSnaks() {
 		return $this->snaks;
@@ -70,7 +69,6 @@ public function count() {
 	 * @return bool
 	 */
 	public function isEmpty() {
-		// FIXME: Not all implementations of Snaks are guaranteed to have an isEmpty method.
 		return $this->snaks->isEmpty();
 	}
 

src/Snak/SnakList.php

@@ -6,16 +6,16 @@
 use Wikibase\DataModel\Internal\MapValueHasher;
 
 /**
- * Implementation of the Snaks interface.
- * @see Snaks
+ * List of Snak objects.
+ * Indexes the snaks by hash and ensures no more the one snak with the same hash are in the list.
  *
  * @since 0.1
  *
  * @licence GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Adam Shorland
  */
-class SnakList extends HashArray implements Snaks {
+class SnakList extends HashArray {
 
 	/**
 	 * @see GenericArrayObject::getObjectType

src/Snak/Snaks.php

@@ -11,7 +11,6 @@
 use Wikibase\DataModel\ReferenceList;
 use Wikibase\DataModel\Snak\Snak;
 use Wikibase\DataModel\Snak\SnakList;
-use Wikibase\DataModel\Snak\Snaks;
 
 /**
  * Class representing a Wikibase statement.
@@ -47,7 +46,7 @@ class Statement implements Hashable, Comparable, PropertyIdProvider {
 	/**
 	 * The property value snaks making up the qualifiers for this statement.
 	 *
-	 * @var Snaks
+	 * @var SnakList
 	 */
 	private $qualifiers;
 
@@ -65,13 +64,13 @@ class Statement implements Hashable, Comparable, PropertyIdProvider {
 	 * @since 2.0
 	 *
 	 * @param Snak $mainSnak
-	 * @param Snaks|null $qualifiers
+	 * @param SnakList|null $qualifiers
 	 * @param ReferenceList|null $references
 	 * @param string|null $guid
 	 */
 	public function __construct(
 		Snak $mainSnak,
-		Snaks $qualifiers = null,
+		SnakList $qualifiers = null,
 		ReferenceList $references = null,
 		$guid = null
 	) {
@@ -136,7 +135,7 @@ public function setMainSnak( Snak $mainSnak ) {
 	 *
 	 * @since 0.1
 	 *
-	 * @return Snaks
+	 * @return SnakList
 	 */
 	public function getQualifiers() {
 		return $this->qualifiers;
@@ -147,9 +146,9 @@ public function getQualifiers() {
 	 *
 	 * @since 0.1
 	 *
-	 * @param Snaks $propertySnaks
+	 * @param SnakList $propertySnaks
 	 */
-	public function setQualifiers( Snaks $propertySnaks ) {
+	public function setQualifiers( SnakList $propertySnaks ) {
 		$this->qualifiers = $propertySnaks;
 	}
 

src/Statement/Statement.php

@@ -13,7 +13,6 @@
 use Wikibase\DataModel\ReferenceList;
 use Wikibase\DataModel\Snak\Snak;
 use Wikibase\DataModel\Snak\SnakList;
-use Wikibase\DataModel\Snak\Snaks;
 
 /**
  * Ordered and non-unique collection of Statement objects.
@@ -92,7 +91,7 @@ public function addStatement( Statement $statement ) {
 
 	/**
 	 * @param Snak $mainSnak
-	 * @param Snak[]|Snaks|null $qualifiers
+	 * @param Snak[]|SnakList|null $qualifiers
 	 * @param Reference[]|ReferenceList|null $references
 	 * @param string|null $guid
 	 */

src/Statement/StatementList.php

@@ -10,7 +10,6 @@
 use Wikibase\DataModel\Snak\PropertySomeValueSnak;
 use Wikibase\DataModel\Snak\PropertyValueSnak;
 use Wikibase\DataModel\Snak\SnakList;
-use Wikibase\DataModel\Snak\Snaks;
 
 /**
  * @covers Wikibase\DataModel\Reference
@@ -73,9 +72,8 @@ public function instanceProvider() {
 
 	/**
 	 * @dataProvider snakListProvider
-	 * @param Snaks $snaks
 	 */
-	public function testConstructor( Snaks $snaks ) {
+	public function testConstructor( SnakList $snaks ) {
 		$omnomnomReference = new Reference( $snaks );
 
 		$this->assertInstanceOf( 'Wikibase\DataModel\Reference', $omnomnomReference );
@@ -111,7 +109,7 @@ public function testGetHashIsTheSameForInstanceWithSameValue( Reference $referen
 	public function testGetSnaks( Reference $reference ) {
 		$snaks = $reference->getSnaks();
 
-		$this->assertInstanceOf( 'Wikibase\DataModel\Snak\Snaks', $snaks );
+		$this->assertInstanceOf( 'Wikibase\DataModel\Snak\SnakList', $snaks );
 	}
 
 	/**

tests/unit/ReferenceTest.php

@@ -38,7 +38,7 @@ public function testMinimalConstructor() {
 	 */
 	public function testConstructorWithValidArguments(
 		Snak $mainSnak,
-		Snaks $qualifiers = null,
+		SnakList $qualifiers = null,
 		ReferenceList $references = null,
 		$guid
 	) {