Merge pull request #720 from wmde/newForeignFromNumber

Add ItemId and PropertyId::newFromRepositoryAndNumber
wmde · Mar 3, 2017 · c7b7b37 · c7b7b37
2 parents d6a55f2 + 671470b
commit c7b7b37
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 0 deletions.
diff --git a/src/Entity/ItemId.php b/src/Entity/ItemId.php
@@ -103,4 +103,21 @@ public static function newFromNumber( $numericId ) {
 		return new self( 'Q' . $numericId );
 	}
 
+	/**
+	 * CAUTION: Use the full string serialization whenever you can and avoid using numeric IDs.
+	 *
+	 * @param string $repositoryName
+	 * @param int|float|string $numericId
+	 *
+	 * @return self
+	 * @throws InvalidArgumentException
+	 */
+	public static function newFromRepositoryAndNumber( $repositoryName, $numericId ) {
+		if ( !is_numeric( $numericId ) ) {
+			throw new InvalidArgumentException( '$numericId must be numeric' );
+		}
+
+		return new self( self::joinSerialization( [ $repositoryName, '', 'Q' . $numericId ] ) );
+	}
+
 }
diff --git a/src/Entity/PropertyId.php b/src/Entity/PropertyId.php
@@ -103,4 +103,21 @@ public static function newFromNumber( $numericId ) {
 		return new self( 'P' . $numericId );
 	}
 
+	/**
+	 * CAUTION: Use the full string serialization whenever you can and avoid using numeric IDs.
+	 *
+	 * @param string $repositoryName
+	 * @param int|float|string $numericId
+	 *
+	 * @return self
+	 * @throws InvalidArgumentException
+	 */
+	public static function newFromRepositoryAndNumber( $repositoryName, $numericId ) {
+		if ( !is_numeric( $numericId ) ) {
+			throw new InvalidArgumentException( '$numericId must be numeric' );
+		}
+
+		return new self( self::joinSerialization( [ $repositoryName, '', 'P' . $numericId ] ) );
+	}
+
 }
diff --git a/tests/unit/Entity/ItemIdTest.php b/tests/unit/Entity/ItemIdTest.php
@@ -156,4 +156,14 @@ public function invalidNumericIdProvider() {
 		];
 	}
 
+	public function testNewFromRepositoryAndNumber() {
+		$id = ItemId::newFromRepositoryAndNumber( 'foo', 1 );
+		$this->assertSame( 'foo:Q1', $id->getSerialization() );
+	}
+
+	public function testNewFromRepositoryAndNumberWithInvalidNumericId() {
+		$this->setExpectedException( InvalidArgumentException::class );
+		ItemId::newFromRepositoryAndNumber( '', 'Q1' );
+	}
+
 }
diff --git a/tests/unit/Entity/PropertyIdTest.php b/tests/unit/Entity/PropertyIdTest.php
@@ -156,4 +156,14 @@ public function invalidNumericIdProvider() {
 		];
 	}
 
+	public function testNewFromRepositoryAndNumber() {
+		$id = PropertyId::newFromRepositoryAndNumber( 'foo', 1 );
+		$this->assertSame( 'foo:P1', $id->getSerialization() );
+	}
+
+	public function testNewFromRepositoryAndNumberWithInvalidNumericId() {
+		$this->setExpectedException( InvalidArgumentException::class );
+		PropertyId::newFromRepositoryAndNumber( '', 'P1' );
+	}
+
 }