Add backwards compatibility with ByPropertyIdArray

Author: Benestar

RELEASE-NOTES.md

@@ -13,6 +13,10 @@
 * Added `ByPropertyIdGrouper`
 * Added `BestStatementsFinder`
 
+#### Deprecations
+
+* Deprecated `ByPropertyIdArray::buildIndex`, `ByPropertyIdArray::getByPropertyId` and `ByPropertyIdArray::getPropertyIds`
+
 ## Version 1.0 (2014-09-02)
 
 #### Breaking changes

src/ByPropertyIdArrayNew.php

@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use OutOfBoundsException;
+use Wikibase\DataModel\Entity\PropertyId;
 
 /**
  * Helper for managing objects grouped by property id.
@@ -40,14 +41,43 @@ public function __construct( array $propertyIdProviders ) {
 		}
 	}
 
+	/**
+	 * @since 0.2
+	 * @deprecated since 1.1
+	 */
+	public function buildIndex() {}
+
+	/**
+	 * @since 0.2
+	 * @deprecated since 1.1
+	 *
+	 * @param PropertyId $propertyId
+	 * @return PropertyIdProvider[]
+	 *
+	 * @throws OutOfBoundsException
+	 */
+	public function getByPropertyId( PropertyId $propertyId ) {
+		return $this->byPropertyIdGrouper->getForPropertyId( $propertyId );
+	}
+
+	/**
+	 * @since 0.2
+	 * @deprecated since 1.1
+	 *
+	 * @return PropertyId[]
+	 */
+	public function getPropertyIds() {
+		return $this->byPropertyIdGrouper->getPropertyIds();
+	}
+
 	/**
 	 * Returns a list of all PropertyIdProvider instances grouped by their PropertyId.
 	 *
-	 * @since 1.1
+	 * @since 0.2
 	 *
 	 * @return PropertyIdProvider[]
 	 */
-	public function getFlatArray() {
+	public function toFlatArray() {
 		return $this->flatArray;
 	}
 
@@ -74,15 +104,15 @@ public function getIndex( PropertyIdProvider $propertyIdProvider ) {
 	/**
 	 * Adds the given PropertyIdProvider to the array at the given index.
 	 *
-	 * @since 1.1
+	 * @since 0.2
 	 *
 	 * @param PropertyIdProvider $propertyIdProvider
 	 * @param int $index
 	 *
 	 * @throws InvalidArgumentException
 	 * @throws OutOfBoundsException
 	 */
-	public function addAtIndex( PropertyIdProvider $propertyIdProvider, $index ) {
+	public function addObjectAtIndex( PropertyIdProvider $propertyIdProvider, $index ) {
 		$this->assertValidIndex( $index );
 
 		$groupIndices = $this->getFlatArrayGroupIndices();
@@ -168,7 +198,7 @@ public function moveToIndex( $oldIndex, $newIndex ) {
 	/**
 	 * Moves the given PropertyIdProvider to the new index and returns it.
 	 *
-	 * @since 1.1
+	 * @since 0.2
 	 *
 	 * @param PropertyIdProvider $propertyIdProvider
 	 * @param int $index
@@ -177,7 +207,7 @@ public function moveToIndex( $oldIndex, $newIndex ) {
 	 * @throws InvalidArgumentException
 	 * @throws OutOfBoundsException
 	 */
-	public function moveObject( PropertyIdProvider $propertyIdProvider, $index ) {
+	public function moveObjectToIndex( PropertyIdProvider $propertyIdProvider, $index ) {
 		return $this->moveToIndex( $this->getIndex( $propertyIdProvider ), $index );
 	}
 

tests/unit/ByPropertyIdArrayNewTest.php

@@ -17,17 +17,17 @@ class ByPropertyIdArrayNewTest extends \PHPUnit_Framework_TestCase {
 	public function testGetFlatArray() {
 		$byPropertyIdArray = $this->getByPropertyIdArray();
 		$expectedTypes = array( 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h' );
-		$this->assertEquals( $expectedTypes, $this->getTypes( $byPropertyIdArray->getFlatArray() ) );
+		$this->assertEquals( $expectedTypes, $this->getTypes( $byPropertyIdArray->toFlatArray() ) );
 	}
 
 	public function testGetIndex() {
 		$byPropertyIdArray = $this->getByPropertyIdArray();
 		$propertyIdProvider = $this->getSnakMock( 'P42', 'foo bar' );
-		$byPropertyIdArray->addAtIndex( $propertyIdProvider, 2 );
+		$byPropertyIdArray->addObjectAtIndex( $propertyIdProvider, 2 );
 		$this->assertEquals( 2, $byPropertyIdArray->getIndex( $propertyIdProvider ) );
 	}
 
-	public function provideAddAtIndex() {
+	public function provideAddObjectAtIndex() {
 		$cases = array();
 
 		$cases[] = array(
@@ -64,12 +64,12 @@ public function provideAddAtIndex() {
 	}
 
 	/**
-	 * @dataProvider provideAddAtIndex
+	 * @dataProvider provideAddObjectAtIndex
 	 */
-	public function testAddAtIndex( PropertyIdProvider $propertyIdProvider, $index, $expectedTypes ) {
+	public function testAddObjectAtIndex( PropertyIdProvider $propertyIdProvider, $index, $expectedTypes ) {
 		$byPropertyIdArray = $this->getByPropertyIdArray();
-		$byPropertyIdArray->addAtIndex( $propertyIdProvider, $index );
-		$this->assertEquals( $expectedTypes, $this->getTypes( $byPropertyIdArray->getFlatArray() ) );
+		$byPropertyIdArray->addObjectAtIndex( $propertyIdProvider, $index );
+		$this->assertEquals( $expectedTypes, $this->getTypes( $byPropertyIdArray->toFlatArray() ) );
 	}
 
 	private function getByPropertyIdArray() {