IBX-6631: Enriched TrashItem with removedLocationContentIdMap

For more details see https://issues.ibexa.co/browse/IBX-6631 and #388 Key changes: * Enriched `TrashItem` with `removedLocationContentIdMap` API `TrashItem` object, when returned as a result of `TrashService::trash` operation, contains a scalar key->value map of trashed Location ID to its Content ID. It includes trashed subtree Locations. Available also via `TrashEvent` to delegate handling of trashed subtree, if needed. * [Tests] Added an integration test coverage for the change
ezsystems · Oct 19, 2023 · 336f0a6 · 336f0a6
1 parent 83cc49f
commit 336f0a6
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 7 deletions.
diff --git a/eZ/Publish/API/Repository/Tests/TrashServiceTest.php b/eZ/Publish/API/Repository/Tests/TrashServiceTest.php
@@ -254,11 +254,6 @@ public function testLoadTrashItem()
             $trashItemReloaded->pathString
         );
 
-        $this->assertEquals(
-            $trashItem,
-            $trashItemReloaded
-        );
-
         $this->assertInstanceOf(
             DateTime::class,
             $trashItemReloaded->trashed
@@ -1041,6 +1036,31 @@ public function testDeleteThrowsNotFoundExceptionForNonExistingTrashItem()
         ));
     }
 
+    public function testTrashProperlyAssignsRemovedLocationContentMapToTrashItem(): void
+    {
+        $repository = $this->getRepository();
+        $trashService = $repository->getTrashService();
+        $locationService = $repository->getLocationService();
+
+        $folder1 = $this->createFolder(['eng-GB' => 'Folder1'], 2);
+        $folder2 = $this->createFolder(['eng-GB' => 'Folder2'], $folder1->contentInfo->getMainLocationId());
+        $folder3 = $this->createFolder(['eng-GB' => 'Folder2'], $folder2->contentInfo->getMainLocationId());
+
+        $folderLocation = $locationService->loadLocation($folder1->contentInfo->getMainLocationId());
+
+        $trashItem = $trashService->trash($folderLocation);
+        $removedLocationContentMap = $trashItem->getRemovedLocationContentIdMap();
+
+        self::assertSame(
+            [
+                $folderLocation->id => $folder1->id,
+                $folder2->contentInfo->getMainLocationId() => $folder2->id,
+                $folder3->contentInfo->getMainLocationId() => $folder3->id,
+            ],
+            $removedLocationContentMap,
+        );
+    }
+
     /**
      * @return array
      */

diff --git a/eZ/Publish/API/Repository/Values/Content/TrashItem.php b/eZ/Publish/API/Repository/Values/Content/TrashItem.php
@@ -19,4 +19,15 @@ abstract class TrashItem extends Location
      * @var \DateTime
      */
     protected $trashed;
+
+    /** @var array<int, int> */
+    protected $removedLocationContentIdMap = [];
+
+    /**
+     * @return array<int, int>
+     */
+    public function getRemovedLocationContentIdMap(): array
+    {
+        return $this->removedLocationContentIdMap;
+    }
 }
diff --git a/eZ/Publish/Core/Persistence/Legacy/Content/Location/Trash/Handler.php b/eZ/Publish/Core/Persistence/Legacy/Content/Location/Trash/Handler.php
@@ -109,6 +109,7 @@ public function trashSubtree($locationId)
         $locationRows = $this->locationGateway->getSubtreeContent($locationId);
         $isLocationRemoved = false;
         $parentLocationId = null;
+        $removedLocationsContentMap = [];
 
         foreach ($locationRows as $locationRow) {
             if ($locationRow['node_id'] == $locationId) {
@@ -117,6 +118,7 @@ public function trashSubtree($locationId)
 
             if ($this->locationGateway->countLocationsByContentId($locationRow['contentobject_id']) == 1) {
                 $this->locationGateway->trashLocation($locationRow['node_id']);
+                $removedLocationsContentMap[(int)$locationRow['node_id']] = (int)$locationRow['contentobject_id'];
             } else {
                 if ($locationRow['node_id'] == $locationId) {
                     $isLocationRemoved = true;
@@ -143,7 +145,14 @@ public function trashSubtree($locationId)
             $this->locationHandler->markSubtreeModified($parentLocationId, time());
         }
 
-        return $isLocationRemoved ? null : $this->loadTrashItem($locationId);
+        if ($isLocationRemoved === true) {
+            return null;
+        }
+
+        $trashItem = $this->loadTrashItem($locationId);
+        $trashItem->removedLocationContentIdMap = $removedLocationsContentMap;
+
+        return $trashItem;
     }
 
     /**

diff --git a/eZ/Publish/Core/Repository/TrashService.php b/eZ/Publish/Core/Repository/TrashService.php
@@ -377,7 +377,10 @@ protected function buildDomainTrashItemObject(Trashed $spiTrashItem, Content $co
                 'depth' => $spiTrashItem->depth,
                 'sortField' => $spiTrashItem->sortField,
                 'sortOrder' => $spiTrashItem->sortOrder,
-                'trashed' => isset($spiTrashItem->trashed) ? new DateTime('@' . $spiTrashItem->trashed) : new DateTime('@0'),
+                'trashed' => isset($spiTrashItem->trashed)
+                    ? new DateTime('@' . $spiTrashItem->trashed)
+                    : new DateTime('@0'),
+                'removedLocationContentIdMap' => $spiTrashItem->removedLocationContentIdMap,
                 'parentLocation' => $this->proxyDomainMapper->createLocationProxy($spiTrashItem->parentId),
             ]
         );

diff --git a/eZ/Publish/SPI/Persistence/Content/Location/Trashed.php b/eZ/Publish/SPI/Persistence/Content/Location/Trashed.php
@@ -19,4 +19,7 @@ class Trashed extends Location
      * @var mixed Trashed timestamp.
      */
     public $trashed;
+
+    /** @var array<int, int> Location ID to a Content ID map of removed items */
+    public $removedLocationContentIdMap = [];
 }