Merge pull request #1175 from schmittjoh/FrKevin-master

Handle discriminator groups

Author: goetas

src/Metadata/ClassMetadata.php

@@ -237,6 +237,7 @@ public function merge(MergeableInterface $object): void
             $this->discriminatorFieldName = $object->discriminatorFieldName;
             $this->discriminatorMap = $object->discriminatorMap;
             $this->discriminatorBaseClass = $object->discriminatorBaseClass;
+            $this->discriminatorGroups = $object->discriminatorGroups;
         }
 
         $this->handleDiscriminatorProperty();

tests/Fixtures/Discriminator/Serialization/Entity.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\Discriminator\Serialization;
+
+use JMS\Serializer\Annotation as JMS;
+use ReflectionClass;
+use ReflectionException;
+
+abstract class Entity
+{
+    /**
+     * @JMS\Type("int")
+     * @JMS\Groups({"base"})
+     * @var int
+     */
+    public $id;
+
+    public function __construct(int $id)
+    {
+        $this->id = $id;
+    }
+
+    /**
+     * @throws ReflectionException
+     *
+     * @JMS\VirtualProperty()
+     * @JMS\SerializedName("entityName")
+     * @JMS\Groups({"entity.identification"})
+     */
+    public function getEntityName(): string
+    {
+        $reflect = new ReflectionClass($this);
+        return $reflect->getShortName();
+    }
+}

tests/Fixtures/Discriminator/Serialization/ExtendedUser.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\Discriminator\Serialization;
+
+use JMS\Serializer\Annotation as JMS;
+
+class ExtendedUser extends User
+{
+    /**
+     * @JMS\Type("string")
+     * @JMS\Groups({"base"})
+     * @var string
+     */
+    public $extendAttribute;
+
+    public function __construct($id, $name, $description, $extendAttribute)
+    {
+        parent::__construct($id, $name, $description);
+        $this->extendAttribute = $extendAttribute;
+    }
+}

tests/Fixtures/Discriminator/Serialization/User.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\Discriminator\Serialization;
+
+use JMS\Serializer\Annotation as JMS;
+
+/**
+ * Class User
+ *
+ * @JMS\Discriminator(field = "entityName",
+ *     groups={"entity.identification"},
+ *     map = {
+ *     "User": "JMS\Serializer\Tests\Fixtures\Discriminator\Serialization\User",
+ *     "ExtendedUser": "JMS\Serializer\Tests\Fixtures\Discriminator\Serialization\ExtendedUser"
+ * })
+ */
+class User extends Entity
+{
+    /**
+     * @JMS\Type("string")
+     * @JMS\Groups({"base"})
+     * @var string
+     */
+    public $name;
+    /**
+     * @JMS\Type("string")
+     * @JMS\Groups({"base"})
+     * @var string
+     */
+    public $description;
+
+    public function __construct(int $id, string $name, string $description)
+    {
+        parent::__construct($id);
+        $this->name = $name;
+        $this->description = $description;
+    }
+}

tests/Serializer/BaseSerializationTest.php

@@ -51,6 +51,8 @@
 use JMS\Serializer\Tests\Fixtures\Discriminator\ImagePost;
 use JMS\Serializer\Tests\Fixtures\Discriminator\Moped;
 use JMS\Serializer\Tests\Fixtures\Discriminator\Post;
+use JMS\Serializer\Tests\Fixtures\Discriminator\Serialization\ExtendedUser;
+use JMS\Serializer\Tests\Fixtures\Discriminator\Serialization\User;
 use JMS\Serializer\Tests\Fixtures\DiscriminatorGroup\Car as DiscriminatorGroupCar;
 use JMS\Serializer\Tests\Fixtures\ExclusionStrategy\AlwaysExcludeExclusionStrategy;
 use JMS\Serializer\Tests\Fixtures\FirstClassListCollection;
@@ -1312,6 +1314,33 @@ public function testPolymorphicObjectsWithGroup()
         );
     }
 
+    public function getDiscrimatorObjectsSamples(): array
+    {
+        $u1 = new User(5, 'userName', 'userDesc');
+        $u2 = new ExtendedUser(5, 'userName', 'userDesc', 'extednedContent');
+        $arr = new ArrayCollection([$u1, $u2]);
+
+        return [
+            [$u1, 'user_discriminator'],
+            [$u2, 'user_discriminator_extended'],
+            [$arr, 'user_discriminator_array'],
+        ];
+    }
+
+    /**
+     * Test serializing entity that uses Discriminator and extends some base model class
+     *
+     * @dataProvider getDiscrimatorObjectsSamples
+     */
+    public function testDiscrimatorObjects($data, $contentId)
+    {
+        $context = SerializationContext::create()->setGroups(['entity.identification']);
+        self::assertEquals(
+            $this->getContent($contentId),
+            $this->serialize($data, $context)
+        );
+    }
+
     /**
      * @group polymorphic
      */

tests/Serializer/JsonSerializationTest.php

@@ -125,6 +125,9 @@ protected function getContent($key)
             $outputs['array_iterator'] = '{"iterator":{"foo":"bar","bar":"foo"}}';
             $outputs['generator'] = '{"generator":{"foo":"bar","bar":"foo"}}';
             $outputs['ParentNoMetadataChildObject'] = '{"bar":"John"}';
+            $outputs['user_discriminator_array'] = '[{"entityName":"User"},{"entityName":"ExtendedUser"}]';
+            $outputs['user_discriminator'] = '{"entityName":"User"}';
+            $outputs['user_discriminator_extended'] = '{"entityName":"ExtendedUser"}';
         }
 
         if (!isset($outputs[$key])) {

tests/Serializer/xml/user_discriminator.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<result>
+  <entityName><![CDATA[User]]></entityName>
+</result>

tests/Serializer/xml/user_discriminator_array.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<result>
+  <entry>
+    <entityName><![CDATA[User]]></entityName>
+  </entry>
+  <entry>
+    <entityName><![CDATA[ExtendedUser]]></entityName>
+  </entry>
+</result>

tests/Serializer/xml/user_discriminator_extended.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<result>
+  <entityName><![CDATA[ExtendedUser]]></entityName>
+</result>