EZP-30968: Added method to count the number of content's reverse relations

eZ/Publish/API/Repository/ContentService.php

@@ -373,6 +373,15 @@ public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $dest
      */
     public function loadRelations(VersionInfo $versionInfo);
 
+    /**
+     * Counts all incoming relations for the given content object.
+     *
+     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
+     *
+     * @return int The number of reverse relations ({@link Relation})
+     */
+    public function countReverseRelations(ContentInfo $contentInfo): int;
+
     /**
      * Loads all incoming relations for a content object.
      *

eZ/Publish/API/Repository/Tests/ContentServiceTest.php

@@ -3490,6 +3490,59 @@ public function testLoadRelationsSkipsDraftContent()
         );
     }
 
+    /**
+     * Test for the countReverseRelations() method.
+     *
+     * @covers \eZ\Publish\API\Repository\ContentService::countReverseRelations
+     */
+    public function testCountReverseRelations(): void
+    {
+        $contentWithReverseRelations = $this->createContentWithReverseRelations([
+            $this->contentService->createContentDraft(
+                $this->createFolder([self::ENG_GB => 'Foo'], 2)->contentInfo
+            ),
+            $this->contentService->createContentDraft(
+                $this->createFolder([self::ENG_GB => 'Bar'], 2)->contentInfo
+            ),
+        ]);
+
+        $contentInfo = $contentWithReverseRelations->content->getVersionInfo()->getContentInfo();
+
+        $this->assertEquals(2, $this->contentService->countReverseRelations($contentInfo));
+    }
+
+    /**
+     * Test for the countReverseRelations() method.
+     *
+     * @covers \eZ\Publish\API\Repository\ContentService::countReverseRelations
+     */
+    public function testCountReverseRelationsReturnsZeroByDefault(): void
+    {
+        $draft = $this->createContentDraftVersion1();
+
+        $this->assertSame(0, $this->contentService->countReverseRelations($draft->getVersionInfo()->getContentInfo()));
+    }
+
+    /**
+     * Test for the countReverseRelations() method.
+     *
+     * @covers \eZ\Publish\API\Repository\ContentService::countReverseRelations
+     */
+    public function testCountReverseRelationsForUnauthorizedUser(): void
+    {
+        $contentWithReverseRelations = $this->createContentWithReverseRelations([
+            $this->contentService->createContentDraft(
+                $this->createFolder([self::ENG_GB => 'Foo'], 2)->contentInfo
+            ),
+        ]);
+        $mediaUser = $this->createMediaUserVersion1();
+        $this->permissionResolver->setCurrentUserReference($mediaUser);
+
+        $contentInfo = $contentWithReverseRelations->content->contentInfo;
+
+        $this->assertSame(0, $this->contentService->countReverseRelations($contentInfo));
+    }
+
     /**
      * Test for the loadReverseRelations() method.
      *
@@ -6164,4 +6217,39 @@ private function createUserWithVersionReadLimitations(array $limitationValues =
             ]
         );
     }
+
+    /**
+     * @param \eZ\Publish\API\Repository\Values\Content\Content[] $drafts
+     *
+     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException
+     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
+     *
+     * @return object
+     */
+    private function createContentWithReverseRelations(array $drafts)
+    {
+        $contentWithReverseRelations = new class() {
+            /** @var \eZ\Publish\API\Repository\Values\Content\Content */
+            public $content;
+
+            /** @var \eZ\Publish\API\Repository\Values\Content\Content[] */
+            public $reverseRelations;
+        };
+        $content = $this->createContentVersion1();
+        $versionInfo = $content->getVersionInfo();
+        $contentInfo = $versionInfo->getContentInfo();
+        $contentWithReverseRelations->content = $content;
+
+        /** @var \eZ\Publish\API\Repository\Values\Content\Content $draft */
+        foreach ($drafts as $draft) {
+            $this->contentService->addRelation(
+                $draft->getVersionInfo(),
+                $contentInfo
+            );
+
+            $contentWithReverseRelations->reverseRelations[] = $this->contentService->publishVersion($draft->getVersionInfo());
+        }
+
+        return $contentWithReverseRelations;
+    }
 }

eZ/Publish/Core/Persistence/Cache/ContentHandler.php

@@ -399,6 +399,16 @@ public function loadRelations($sourceContentId, $sourceContentVersionNo = null,
         return $this->persistenceHandler->contentHandler()->loadRelations($sourceContentId, $sourceContentVersionNo, $type);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(int $destinationContentId, ?int $type = null): int
+    {
+        $this->logger->logCall(__METHOD__, ['content' => $destinationContentId, 'type' => $type]);
+
+        return $this->persistenceHandler->contentHandler()->countReverseRelations($destinationContentId, $type);
+    }
+
     /**
      * {@inheritdoc}
      */

eZ/Publish/Core/Persistence/Legacy/Content/Gateway.php

@@ -400,6 +400,16 @@ abstract public function deleteContent($contentId);
      */
     abstract public function loadRelations($contentId, $contentVersionNo = null, $relationType = null);
 
+    /**
+     * Counts number of related to/from $contentId.
+     *
+     * @param int $contentId
+     * @param int|null $relationType
+     *
+     * @return int
+     */
+    abstract public function countReverseRelations(int $contentId, ?int $relationType = null): int;
+
     /**
      * Loads data of related to/from $contentId.
      *

eZ/Publish/Core/Persistence/Legacy/Content/Gateway/DoctrineDatabase.php

@@ -1940,6 +1940,45 @@ public function loadRelations($contentId, $contentVersionNo = null, $relationTyp
         return $statement->fetchAll(\PDO::FETCH_ASSOC);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(int $toContentId, ?int $relationType = null): int
+    {
+        $platform = $this->connection->getDatabasePlatform();
+        $query = $this->connection->createQueryBuilder();
+        $expr = $query->expr();
+        $query
+            ->select($platform->getCountExpression('l.id'))
+            ->from('ezcontentobject_link', 'l')
+            ->innerJoin(
+                'l',
+                'ezcontentobject',
+                'c',
+                $expr->andX(
+                    $expr->eq('l.from_contentobject_id', 'c.id'),
+                    $expr->eq('l.from_contentobject_version', 'c.current_version'),
+                    $expr->eq('c.status', 1)
+                )
+            )
+            ->where(
+                $expr->eq('l.to_contentobject_id', ':toContentId')
+            )
+            ->setParameter(':toContentId', $toContentId, ParameterType::INTEGER);
+
+        // relation type
+        if ($relationType !== null) {
+            $query->andWhere(
+                $expr->gt(
+                    $platform->getBitAndComparisonExpression('l.relation_type', $relationType),
+                    0
+                )
+            );
+        }
+
+        return (int) $query->execute()->fetchColumn();
+    }
+
     /**
      * Loads data that related to $toContentId.
      *

eZ/Publish/Core/Persistence/Legacy/Content/Gateway/ExceptionConversion.php

@@ -693,6 +693,18 @@ public function loadRelations($contentId, $contentVersionNo = null, $relationTyp
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(int $contentId, ?int $relationType = null): int
+    {
+        try {
+            return $this->innerGateway->countReverseRelations($contentId, $relationType);
+        } catch (DBALException | PDOException $e) {
+            throw new RuntimeException('Database error', 0, $e);
+        }
+    }
+
     /**
      * Loads data of related to/from $contentId.
      *

eZ/Publish/Core/Persistence/Legacy/Content/Handler.php

@@ -819,6 +819,14 @@ public function loadRelations($sourceContentId, $sourceContentVersionNo = null,
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(int $destinationContentId, ?int $type = null): int
+    {
+        return $this->contentGateway->countReverseRelations($destinationContentId, $type);
+    }
+
     /**
      * Loads relations from $contentId. Optionally, loads only those with $type.
      *

eZ/Publish/Core/REST/Client/ContentService.php

@@ -617,6 +617,14 @@ public function loadRelations(VersionInfo $versionInfo)
         throw new \Exception('@todo: Implement.');
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(ContentInfo $contentInfo): int
+    {
+        throw new \Exception('@todo: Implement.');
+    }
+
     /**
      * Loads all incoming relations for a content object.
      *

eZ/Publish/Core/Repository/ContentService.php

@@ -1943,6 +1943,20 @@ public function loadRelations(APIVersionInfo $versionInfo)
         return $relations;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(ContentInfo $contentInfo): int
+    {
+        if (!$this->repository->canUser('content', 'reverserelatedlist', $contentInfo)) {
+            return 0;
+        }
+
+        return $this->persistenceHandler->contentHandler()->countReverseRelations(
+            $contentInfo->id
+        );
+    }
+
     /**
      * Loads all incoming relations for a content object.
      *

eZ/Publish/Core/Repository/SiteAccessAware/ContentService.php

@@ -178,6 +178,14 @@ public function loadRelations(VersionInfo $versionInfo)
         return $this->service->loadRelations($versionInfo);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(ContentInfo $contentInfo): int
+    {
+        return $this->service->countReverseRelations($contentInfo);
+    }
+
     public function loadReverseRelations(ContentInfo $contentInfo)
     {
         return $this->service->loadReverseRelations($contentInfo);

eZ/Publish/Core/Repository/SiteAccessAware/Tests/ContentServiceTest.php

@@ -85,6 +85,8 @@ public function providerForPassTroughMethods()
 
             ['loadRelations', [$versionInfo]],
 
+            ['countReverseRelations', [$contentInfo]],
+
             ['loadReverseRelations', [$contentInfo]],
 
             ['addRelation', [$versionInfo, $contentInfo]],

eZ/Publish/Core/SignalSlot/ContentService.php

@@ -520,6 +520,14 @@ public function loadRelations(VersionInfo $versionInfo)
         return $this->service->loadRelations($versionInfo);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function countReverseRelations(ContentInfo $contentInfo): int
+    {
+        return $this->service->countReverseRelations($contentInfo);
+    }
+
     /**
      * Loads all incoming relations for a content object.
      *

eZ/Publish/Core/SignalSlot/Tests/ContentServiceTest.php

@@ -252,6 +252,12 @@ public function serviceProvider()
                 $relations,
                 0,
             ],
+            [
+                'countReverseRelations',
+                [$contentInfo],
+                0,
+                0,
+            ],
             [
                 'loadReverseRelations',
                 [$contentInfo],

eZ/Publish/SPI/Persistence/Content/Handler.php

@@ -289,6 +289,16 @@ public function removeRelation($relationId, $type);
      */
     public function loadRelations($sourceContentId, $sourceContentVersionNo = null, $type = null);
 
+    /**
+     * Counts relations from $destinationContentId only against published versions. Optionally, count only those with $type.
+     *
+     * @param int $destinationContentId Destination Content ID
+     * @param int|null $type The relation type bitmask {@see \eZ\Publish\API\Repository\Values\Content\Relation}
+     *
+     * @return int
+     */
+    public function countReverseRelations(int $destinationContentId, ?int $type = null): int;
+
     /**
      * Loads relations from $contentId. Optionally, loads only those with $type.
      *