Merge pull request #1254 from marein/allow-interfaces-for-typed-prope…

…rties Allow interfaces for typed properties
schmittjoh · Nov 8, 2020 · 0b740bc · 0b740bc
2 parents 0ed0b6a + 8c596c6
commit 0b740bc
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 2 deletions.
diff --git a/src/Metadata/Driver/TypedPropertiesDriver.php b/src/Metadata/Driver/TypedPropertiesDriver.php
@@ -112,6 +112,7 @@ private function shouldTypeHint(ReflectionProperty $propertyReflection): bool
             return true;
         }
 
-        return class_exists($propertyReflection->getType()->getName());
+        return class_exists($propertyReflection->getType()->getName())
+            || interface_exists($propertyReflection->getType()->getName());
     }
 }
diff --git a/tests/Fixtures/TypedProperties/Car.php b/tests/Fixtures/TypedProperties/Car.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\TypedProperties;
+
+class Car implements Vehicle
+{
+}
diff --git a/tests/Fixtures/TypedProperties/User.php b/tests/Fixtures/TypedProperties/User.php
@@ -10,6 +10,7 @@ class User
 {
     public int $id;
     public Role $role;
+    public Vehicle $vehicle;
     public \DateTime $created;
 
     /**

diff --git a/tests/Fixtures/TypedProperties/Vehicle.php b/tests/Fixtures/TypedProperties/Vehicle.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\TypedProperties;
+
+use JMS\Serializer\Annotation as Serializer;
+
+/**
+ * @Serializer\Discriminator(field = "type", map = {
+ *    "car": "JMS\Serializer\Tests\Fixtures\TypedProperties\Car",
+ * })
+ */
+interface Vehicle
+{
+}
diff --git a/tests/Metadata/Driver/TypedPropertiesDriverTest.php b/tests/Metadata/Driver/TypedPropertiesDriverTest.php
@@ -22,6 +22,7 @@ public function testInferPropertiesFromTypes()
         $expectedPropertyTypes = [
             'id' => 'int',
             'role' => 'JMS\Serializer\Tests\Fixtures\TypedProperties\Role',
+            'vehicle' => 'JMS\Serializer\Tests\Fixtures\TypedProperties\Vehicle',
             'created' => 'DateTime',
             'tags' => 'iterable',
         ];

diff --git a/tests/Serializer/BaseSerializationTest.php b/tests/Serializer/BaseSerializationTest.php
@@ -1356,6 +1356,10 @@ public function testTypedProperties()
             $this->markTestSkipped(sprintf('%s requires PHP 7.4', __METHOD__));
         }
 
+        $builder = SerializerBuilder::create($this->handlerRegistry, $this->dispatcher);
+        $builder->includeInterfaceMetadata(true);
+        $this->serializer = $builder->build();
+
         $user = new TypedProperties\User();
         $user->id = 1;
         $user->created = new \DateTime('2010-10-01 00:00:00');
@@ -1364,6 +1368,7 @@ public function testTypedProperties()
         $role = new TypedProperties\Role();
         $role->id = 5;
         $user->role = $role;
+        $user->vehicle = new TypedProperties\Car();
 
         $result = $this->serialize($user);
 

diff --git a/tests/Serializer/JsonSerializationTest.php b/tests/Serializer/JsonSerializationTest.php
@@ -129,7 +129,7 @@ protected function getContent($key)
             $outputs['user_discriminator_array'] = '[{"entityName":"User"},{"entityName":"ExtendedUser"}]';
             $outputs['user_discriminator'] = '{"entityName":"User"}';
             $outputs['user_discriminator_extended'] = '{"entityName":"ExtendedUser"}';
-            $outputs['typed_props'] = '{"id":1,"role":{"id":5},"created":"2010-10-01T00:00:00+00:00","updated":"2011-10-01T00:00:00+00:00","tags":["a","b"]}';
+            $outputs['typed_props'] = '{"id":1,"role":{"id":5},"vehicle":{"type":"car"},"created":"2010-10-01T00:00:00+00:00","updated":"2011-10-01T00:00:00+00:00","tags":["a","b"]}';
         }
 
         if (!isset($outputs[$key])) {

diff --git a/tests/Serializer/xml/typed_props.xml b/tests/Serializer/xml/typed_props.xml
@@ -4,6 +4,9 @@
   <role>
     <id>5</id>
   </role>
+  <vehicle>
+    <type><![CDATA[car]]></type>
+  </vehicle>
   <created><![CDATA[2010-10-01T00:00:00+00:00]]></created>
   <updated><![CDATA[2011-10-01T00:00:00+00:00]]></updated>
   <tags>