Merge pull request #718 from wmde/idSerialize

Rework native EntityId(Value) serializations

Author: Daniel Kinzler

src/Entity/EntityIdValue.php

@@ -30,10 +30,7 @@ public function __construct( EntityId $entityId ) {
 	 * @return string
 	 */
 	public function serialize() {
-		return json_encode( [
-			$this->entityId->getEntityType(),
-			$this->getNumericId()
-		] );
+		return serialize( $this->entityId );
 	}
 
 	/**
@@ -58,7 +55,14 @@ private function getNumericId() {
 	 * @throws IllegalValueException
 	 */
 	public function unserialize( $serialized ) {
-		list( $entityType, $numericId ) = json_decode( $serialized );
+		$array = json_decode( $serialized );
+
+		if ( !is_array( $array ) ) {
+			$this->entityId = unserialize( $serialized );
+			return;
+		}
+
+		list( $entityType, $numericId ) = $array;
 
 		try {
 			$entityId = LegacyIdInterpreter::newIdFromTypeAndNumber( $entityType, $numericId );

src/Entity/ItemId.php

@@ -70,7 +70,7 @@ public function getEntityType() {
 	 * @return string
 	 */
 	public function serialize() {
-		return json_encode( [ 'item', $this->serialization ] );
+		return $this->serialization;
 	}
 
 	/**
@@ -79,7 +79,8 @@ public function serialize() {
 	 * @param string $serialized
 	 */
 	public function unserialize( $serialized ) {
-		list( , $this->serialization ) = json_decode( $serialized );
+		$array = json_decode( $serialized );
+		$this->serialization = is_array( $array ) ? $array[1] : $serialized;
 	}
 
 	/**

src/Entity/PropertyId.php

@@ -70,7 +70,7 @@ public function getEntityType() {
 	 * @return string
 	 */
 	public function serialize() {
-		return json_encode( [ 'property', $this->serialization ] );
+		return $this->serialization;
 	}
 
 	/**
@@ -79,7 +79,8 @@ public function serialize() {
 	 * @param string $serialized
 	 */
 	public function unserialize( $serialized ) {
-		list( , $this->serialization ) = json_decode( $serialized );
+		$array = json_decode( $serialized );
+		$this->serialization = is_array( $array ) ? $array[1] : $serialized;
 	}
 
 	/**

tests/unit/Entity/EntityIdTest.php

@@ -69,12 +69,12 @@ public function testDeserializationCompatibility() {
 	 * It is just here to catch unintentional changes.
 	 */
 	public function testSerializationStability() {
-		$v05serialization = 'C:32:"Wikibase\DataModel\Entity\ItemId":15:{["item","Q123"]}';
+		$serialization = 'C:32:"Wikibase\DataModel\Entity\ItemId":4:{Q123}';
 		$id = new ItemId( 'q123' );
 
 		$this->assertEquals(
 			serialize( $id ),
-			$v05serialization
+			$serialization
 		);
 	}
 

tests/unit/Entity/EntityIdValueTest.php

@@ -87,8 +87,7 @@ public function testGetArrayValueRoundtrip( EntityIdValue $id ) {
 	public function testSerializationCompatibility() {
 		$id = new EntityIdValue( new ItemId( 'Q31337' ) );
 
-		// This is the serialization format from when the EntityIdValue was still together with EntityId.
-		$this->assertEquals( '["item",31337]', $id->serialize() );
+		$this->assertEquals( 'C:32:"Wikibase\DataModel\Entity\ItemId":6:{Q31337}', $id->serialize() );
 	}
 
 	public function testDeserializationCompatibility() {

tests/unit/Entity/ItemIdTest.php

@@ -92,7 +92,7 @@ public function testGetEntityType() {
 
 	public function testSerialize() {
 		$id = new ItemId( 'Q1' );
-		$this->assertSame( '["item","Q1"]', $id->serialize() );
+		$this->assertSame( 'Q1', $id->serialize() );
 	}
 
 	/**
@@ -106,6 +106,7 @@ public function testUnserialize( $json, $expected ) {
 
 	public function serializationProvider() {
 		return [
+			[ 'Q2', 'Q2' ],
 			[ '["item","Q2"]', 'Q2' ],
 
 			// All these cases are kind of an injection vector and allow constructing invalid ids.
@@ -114,7 +115,7 @@ public function serializationProvider() {
 			[ '["",""]', '' ],
 			[ '["",2]', 2 ],
 			[ '["",null]', null ],
-			[ '', null ],
+			[ '', '' ],
 		];
 	}
 

tests/unit/Entity/PropertyIdTest.php

@@ -92,7 +92,7 @@ public function testGetEntityType() {
 
 	public function testSerialize() {
 		$id = new PropertyId( 'P1' );
-		$this->assertSame( '["property","P1"]', $id->serialize() );
+		$this->assertSame( 'P1', $id->serialize() );
 	}
 
 	/**
@@ -106,6 +106,7 @@ public function testUnserialize( $json, $expected ) {
 
 	public function serializationProvider() {
 		return [
+			[ 'P2', 'P2' ],
 			[ '["property","P2"]', 'P2' ],
 
 			// All these cases are kind of an injection vector and allow constructing invalid ids.
@@ -114,7 +115,7 @@ public function serializationProvider() {
 			[ '["",""]', '' ],
 			[ '["",2]', 2 ],
 			[ '["",null]', null ],
-			[ '', null ],
+			[ '', '' ],
 		];
 	}