Merge pull request #1357 from re2bit/master

add support for persistent collections so orphan removal works
schmittjoh · Nov 8, 2021 · e2724bd · e2724bd
2 parents 832c8f2 + 1aa5bfa
commit e2724bd
Show file tree

Hide file tree

Showing 6 changed files with 364 additions and 36 deletions.
diff --git a/.run/phpunit.run.xml b/.run/phpunit.run.xml
@@ -0,0 +1,6 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="phpunit" type="PHPUnitRunConfigurationType" factoryName="PHPUnit">
+    <TestRunner configuration_file="$PROJECT_DIR$/phpunit.xml.dist" scope="XML" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/src/Construction/DoctrineObjectConstructor.php b/src/Construction/DoctrineObjectConstructor.php
@@ -13,6 +13,8 @@
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 
+use function is_array;
+
 /**
  * Doctrine object constructor for new (or existing) objects during deserialization.
  */
@@ -79,7 +81,7 @@ public function construct(DeserializationVisitorInterface $visitor, ClassMetadat
         }
 
         // Managed entity, check for proxy load
-        if (!\is_array($data) && !(is_object($data) && 'SimpleXMLElement' === get_class($data))) {
+        if (!is_array($data) && !(is_object($data) && 'SimpleXMLElement' === get_class($data))) {
             // Single identifier, load proxy
             return $objectManager->getReference($metadata->name, $data);
         }

diff --git a/src/Handler/ArrayCollectionHandler.php b/src/Handler/ArrayCollectionHandler.php
@@ -9,22 +9,40 @@
 use Doctrine\ODM\MongoDB\PersistentCollection as MongoPersistentCollection;
 use Doctrine\ODM\PHPCR\PersistentCollection as PhpcrPersistentCollection;
 use Doctrine\ORM\PersistentCollection as OrmPersistentCollection;
+use Doctrine\Persistence\ManagerRegistry;
 use JMS\Serializer\DeserializationContext;
 use JMS\Serializer\GraphNavigatorInterface;
+use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\SerializationContext;
 use JMS\Serializer\Visitor\DeserializationVisitorInterface;
 use JMS\Serializer\Visitor\SerializationVisitorInterface;
 
 final class ArrayCollectionHandler implements SubscribingHandlerInterface
 {
+    public const COLLECTION_TYPES = [
+        'ArrayCollection',
+        ArrayCollection::class,
+        OrmPersistentCollection::class,
+        MongoPersistentCollection::class,
+        PhpcrPersistentCollection::class,
+    ];
+
     /**
      * @var bool
      */
     private $initializeExcluded;
 
-    public function __construct(bool $initializeExcluded = true)
-    {
+    /**
+     * @var ManagerRegistry|null
+     */
+    private $managerRegistry;
+
+    public function __construct(
+        bool $initializeExcluded = true,
+        ?ManagerRegistry $managerRegistry = null
+    ) {
         $this->initializeExcluded = $initializeExcluded;
+        $this->managerRegistry = $managerRegistry;
     }
 
     /**
@@ -34,15 +52,8 @@ public static function getSubscribingMethods()
     {
         $methods = [];
         $formats = ['json', 'xml', 'yml'];
-        $collectionTypes = [
-            'ArrayCollection',
-            ArrayCollection::class,
-            OrmPersistentCollection::class,
-            MongoPersistentCollection::class,
-            PhpcrPersistentCollection::class,
-        ];
-
-        foreach ($collectionTypes as $type) {
+
+        foreach (self::COLLECTION_TYPES as $type) {
             foreach ($formats as $format) {
                 $methods[] = [
                     'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
@@ -92,11 +103,59 @@ public function serializeCollection(SerializationVisitorInterface $visitor, Coll
     /**
      * @param mixed $data
      */
-    public function deserializeCollection(DeserializationVisitorInterface $visitor, $data, array $type, DeserializationContext $context): ArrayCollection
-    {
+    public function deserializeCollection(
+        DeserializationVisitorInterface $visitor,
+        $data,
+        array $type,
+        DeserializationContext $context
+    ): Collection {
         // See above.
         $type['name'] = 'array';
 
-        return new ArrayCollection($visitor->visitArray($data, $type));
+        $elements = new ArrayCollection($visitor->visitArray($data, $type));
+
+        if (null === $this->managerRegistry) {
+            return $elements;
+        }
+
+        $propertyMetadata = $context->getMetadataStack()->top();
+        if (!$propertyMetadata instanceof PropertyMetadata) {
+            return $elements;
+        }
+
+        $objectManager = $this->managerRegistry->getManagerForClass($propertyMetadata->class);
+        if (null === $objectManager) {
+            return $elements;
+        }
+
+        $classMetadata = $objectManager->getClassMetadata($propertyMetadata->class);
+        $currentObject = $visitor->getCurrentObject();
+
+        if (
+            array_key_exists('name', $propertyMetadata->type)
+            && in_array($propertyMetadata->type['name'], self::COLLECTION_TYPES)
+            && $classMetadata->isCollectionValuedAssociation($propertyMetadata->name)
+        ) {
+            $existingCollection = $classMetadata->getFieldValue($currentObject, $propertyMetadata->name);
+            if (!$existingCollection instanceof OrmPersistentCollection) {
+                return $elements;
+            }
+
+            foreach ($elements as $element) {
+                if (!$existingCollection->contains($element)) {
+                    $existingCollection->add($element);
+                }
+            }
+
+            foreach ($existingCollection as $collectionElement) {
+                if (!$elements->contains($collectionElement)) {
+                    $existingCollection->removeElement($collectionElement);
+                }
+            }
+
+            return $existingCollection;
+        }
+
+        return $elements;
     }
 }
diff --git a/tests/Fixtures/Doctrine/PersistendCollection/App.php b/tests/Fixtures/Doctrine/PersistendCollection/App.php
@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\Doctrine\PersistendCollection;
+
+use Doctrine\ORM\Mapping as ORM;
+use JMS\Serializer\Annotation as Serializer;
+
+/** @ORM\Entity */
+class App
+{
+    /**
+     * @Serializer\SerializedName("id")
+     * @Serializer\Type("string")
+     * @ORM\Id
+     * @ORM\Column(type="string", name="id")
+     *
+     * @var string
+     */
+    #[Serializer\Type(name: 'string')]
+    protected $id;
+
+    /**
+     * @Serializer\Type("string")
+     * @ORM\Column(type="string")
+     *
+     * @var string
+     */
+    #[Serializer\Type(name: 'string')]
+    private $name;
+
+    /**
+     * @ORM\ManyToOne(targetEntity="SmartPhone")
+     *
+     * @var SmartPhone
+     */
+    #[Serializer\Type(name: SmartPhone::class)]
+    private $smartPhone;
+
+    /**
+     * @param string $id
+     * @param string $name
+     * @param string $smartPhone
+     */
+    public function __construct(
+        $id,
+        $name,
+        $smartPhone
+    ) {
+        $this->id = $id;
+        $this->name = $name;
+        $this->smartPhone = $smartPhone;
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getSmartPhone(): SmartPhone
+    {
+        return $this->smartPhone;
+    }
+}
diff --git a/tests/Fixtures/Doctrine/PersistendCollection/SmartPhone.php b/tests/Fixtures/Doctrine/PersistendCollection/SmartPhone.php
@@ -0,0 +1,90 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\Doctrine\PersistendCollection;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Collections\Criteria;
+use Doctrine\ORM\Mapping as ORM;
+use JMS\Serializer\Annotation as Serializer;
+
+/** @ORM\Entity */
+class SmartPhone
+{
+    /**
+     * @Serializer\SerializedName("id")
+     * @Serializer\Type("string")
+     * @ORM\Id
+     * @ORM\Column(type="string", name="id")
+     *
+     * @var string
+     */
+    #[Serializer\Type(name: 'string')]
+    protected $id;
+
+    /**
+     * @Serializer\Type("string")
+     * @ORM\Column(type="string")
+     *
+     * @var string
+     */
+    #[Serializer\Type(name: 'string')]
+    private $name;
+
+    /**
+     * @Serializer\Type("ArrayCollection<JMS\Serializer\Tests\Fixtures\Doctrine\PersistendCollection\App>")
+     * @Serializer\SerializedName("applications")
+     * @ORM\OneToMany (targetEntity="App", mappedBy="smartPhone", cascade={"persist"}, orphanRemoval=true)
+     *
+     * @var ArrayCollection<int, App>
+     */
+    #[Serializer\Type(name: 'ArrayCollection<JMS\Serializer\Tests\Fixtures\Doctrine\PersistendCollection\App>')]
+    private $apps;
+
+    /**
+     * @param string $name
+     * @param string $phoneId
+     */
+    public function __construct($name, $phoneId)
+    {
+        $this->name = $name;
+        $this->id = $phoneId;
+        $this->apps = new ArrayCollection();
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function addApp(App $app): void
+    {
+        $this->apps[] = $app;
+    }
+
+    /**
+     * @param Criteria|null $criteria
+     *
+     * @return Collection<int, App>
+     */
+    public function getApps(?Criteria $criteria = null): Collection
+    {
+        if (null === $criteria) {
+            $criteria = Criteria::create();
+        }
+
+        return $this->apps->matching($criteria);
+    }
+
+    public function getAppsRaw(): Collection
+    {
+        return $this->apps;
+    }
+}