IBX-5905: Implemented LoadContent events

phpstan-baseline.neon

@@ -62664,3 +62664,8 @@ parameters:
 			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\Specification\\\\Content\\\\ContentTypeSpecificationTest\\:\\:providerForIsSatisfiedBy\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
 			path: tests/lib/Specification/Content/ContentTypeSpecificationTest.php
+
+		-
+			message: "#^Method Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Events\\\\Content\\\\BeforeLoadContentEvent\\:\\:getContent\\(\\) should return Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Content but returns Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Content\\|null\\.$#"
+			count: 1
+			path: src/contracts/Repository/Events/Content/BeforeLoadContentEvent.php

src/contracts/Persistence/Content/ContentInfo.php

@@ -43,6 +43,8 @@ class ContentInfo extends ValueObject
      */
     public $contentTypeId;
 
+    public string $contentTypeIdentifier;
+
     /**
      * Section id the content is assigned to.
      *
@@ -134,6 +136,11 @@ class ContentInfo extends ValueObject
      * @var bool
      */
     public $isHidden = false;
+
+    public function getContentTypeIdentifier(): string
+    {
+        return $this->contentTypeIdentifier;
+    }
 }
 
 class_alias(ContentInfo::class, 'eZ\Publish\SPI\Persistence\Content\ContentInfo');

src/contracts/Repository/Events/Content/BeforeLoadContentEvent.php

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Repository\Events\Content;
+
+use Ibexa\Contracts\Core\Repository\Event\BeforeEvent;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use UnexpectedValueException;
+
+final class BeforeLoadContentEvent extends BeforeEvent
+{
+    private int $contentId;
+
+    /** @var string[]|null */
+    private ?array $languages;
+
+    private ?int $versionNo;
+
+    private bool $useAlwaysAvailable;
+
+    private ?Content $content = null;
+
+    /**
+     * @param string[] $languages
+     */
+    public function __construct(
+        int $contentId,
+        array $languages = null,
+        ?int $versionNo = null,
+        bool $useAlwaysAvailable = true
+    ) {
+        $this->contentId = $contentId;
+        $this->languages = $languages;
+        $this->versionNo = $versionNo;
+        $this->useAlwaysAvailable = $useAlwaysAvailable;
+    }
+
+    public function getContentId(): int
+    {
+        return $this->contentId;
+    }
+
+    /**
+     * @return string[]|null
+     */
+    public function getLanguages(): ?array
+    {
+        return $this->languages;
+    }
+
+    public function getVersionNo(): ?int
+    {
+        return $this->versionNo;
+    }
+
+    public function getUseAlwaysAvailable(): bool
+    {
+        return $this->useAlwaysAvailable;
+    }
+
+    public function getContent(): Content
+    {
+        if (!$this->hasContent()) {
+            throw new UnexpectedValueException(sprintf('Return value is not set or not of type %s. Check hasContent() or set it using setContent() before you call the getter.', Content::class));
+        }
+
+        return $this->content;
+    }
+
+    public function setContent(?Content $content): void
+    {
+        $this->content = $content;
+    }
+
+    public function hasContent(): bool
+    {
+        return $this->content instanceof Content;
+    }
+}

src/lib/Event/ContentService.php

@@ -20,6 +20,7 @@
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforeDeleteTranslationEvent;
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforeDeleteVersionEvent;
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforeHideContentEvent;
+use Ibexa\Contracts\Core\Repository\Events\Content\BeforeLoadContentEvent;
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforePublishVersionEvent;
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforeRevealContentEvent;
 use Ibexa\Contracts\Core\Repository\Events\Content\BeforeUpdateContentEvent;
@@ -380,6 +381,31 @@ public function revealContent(ContentInfo $contentInfo): void
             new RevealContentEvent(...$eventData)
         );
     }
+
+    public function loadContent(
+        int $contentId,
+        array $languages = null,
+        ?int $versionNo = null,
+        bool $useAlwaysAvailable = true
+    ): Content {
+        $eventData = [
+            $contentId,
+            $languages,
+            $versionNo,
+            $useAlwaysAvailable,
+        ];
+
+        $beforeEvent = new BeforeLoadContentEvent(...$eventData);
+
+        $this->eventDispatcher->dispatch($beforeEvent);
+        if ($beforeEvent->isPropagationStopped()) {
+            return $beforeEvent->getContent();
+        }
+
+        return $beforeEvent->hasContent()
+            ? $beforeEvent->getContent()
+            : $this->innerService->loadContent($contentId, $languages, $versionNo, $useAlwaysAvailable);
+    }
 }
 
 class_alias(ContentService::class, 'eZ\Publish\Core\Event\ContentService');

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase.php

@@ -20,6 +20,7 @@
 use Ibexa\Contracts\Core\Persistence\Content\Language\Handler as LanguageHandler;
 use Ibexa\Contracts\Core\Persistence\Content\MetadataUpdateStruct;
 use Ibexa\Contracts\Core\Persistence\Content\Relation\CreateStruct as RelationCreateStruct;
+use Ibexa\Contracts\Core\Persistence\Content\Type;
 use Ibexa\Contracts\Core\Persistence\Content\UpdateStruct;
 use Ibexa\Contracts\Core\Persistence\Content\VersionInfo;
 use Ibexa\Contracts\Core\Repository\Values\Content\Relation;
@@ -769,14 +770,15 @@ private function internalLoadContent(
                 'a.data_text AS ezcontentobject_attribute_data_text',
                 'a.sort_key_int AS ezcontentobject_attribute_sort_key_int',
                 'a.sort_key_string AS ezcontentobject_attribute_sort_key_string',
-                't.main_node_id AS ezcontentobject_tree_main_node_id'
+                't.main_node_id AS ezcontentobject_tree_main_node_id',
+                'ct.identifier AS content_type_identifier',
             )
             ->from('ezcontentobject', 'c')
             ->innerJoin(
                 'c',
                 'ezcontentobject_version',
                 'v',
-                $expr->andX(
+                $expr->and(
                     $expr->eq('c.id', 'v.contentobject_id'),
                     $expr->eq('v.version', $version ?? 'c.current_version')
                 )
@@ -785,7 +787,7 @@ private function internalLoadContent(
                 'v',
                 'ezcontentobject_attribute',
                 'a',
-                $expr->andX(
+                $expr->and(
                     $expr->eq('v.contentobject_id', 'a.contentobject_id'),
                     $expr->eq('v.version', 'a.version')
                 )
@@ -794,10 +796,19 @@ private function internalLoadContent(
                 'c',
                 'ezcontentobject_tree',
                 't',
-                $expr->andX(
+                $expr->and(
                     $expr->eq('c.id', 't.contentobject_id'),
                     $expr->eq('t.node_id', 't.main_node_id')
                 )
+            )
+            ->innerJoin(
+                'c',
+                'ezcontentclass',
+                'ct',
+                $expr->and(
+                    $expr->eq('c.contentclass_id', 'ct.id'),
+                    $expr->eq('ct.version', Type::STATUS_DEFINED)
+                )
             );
 
         $queryBuilder->where(

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase/QueryBuilder.php

@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Query\QueryBuilder as DoctrineQueryBuilder;
+use Ibexa\Contracts\Core\Persistence\Content\Type;
 use Ibexa\Core\Persistence\Legacy\Content\Gateway;
 use function time;
 
@@ -113,13 +114,26 @@ public function createLoadContentInfoQueryBuilder(
         }
 
         $queryBuilder
-            ->select('c.*', 't.main_node_id AS ezcontentobject_tree_main_node_id')
+            ->select(
+                'c.*',
+                't.main_node_id AS ezcontentobject_tree_main_node_id',
+                'ct.identifier AS content_type_identifier'
+            )
             ->from(Gateway::CONTENT_ITEM_TABLE, 'c')
             ->leftJoin(
                 'c',
                 'ezcontentobject_tree',
                 't',
                 $joinCondition
+            )
+            ->innerJoin(
+                'c',
+                'ezcontentclass',
+                'ct',
+                $expr->and(
+                    $expr->eq('c.contentclass_id', 'ct.id'),
+                    $expr->eq('ct.version', Type::STATUS_DEFINED)
+                )
             );
 
         return $queryBuilder;
@@ -163,7 +177,8 @@ public function createVersionInfoFindQueryBuilder(): DoctrineQueryBuilder
                 'c.status AS ezcontentobject_status',
                 'c.name AS ezcontentobject_name',
                 'c.language_mask AS ezcontentobject_language_mask',
-                'c.is_hidden AS ezcontentobject_is_hidden'
+                'c.is_hidden AS ezcontentobject_is_hidden',
+                'ct.identifier AS content_type_identifier'
             )
             ->from(Gateway::CONTENT_VERSION_TABLE, 'v')
             ->innerJoin(
@@ -180,6 +195,15 @@ public function createVersionInfoFindQueryBuilder(): DoctrineQueryBuilder
                     $expr->eq('t.contentobject_id', 'v.contentobject_id'),
                     $expr->eq('t.main_node_id', 't.node_id')
                 )
+            )
+            ->innerJoin(
+                'c',
+                'ezcontentclass',
+                'ct',
+                $expr->and(
+                    $expr->eq('c.contentclass_id', 'ct.id'),
+                    $expr->eq('ct.version', Type::STATUS_DEFINED)
+                )
             );
 
         return $query;

src/lib/Persistence/Legacy/Content/Mapper.php

@@ -370,12 +370,16 @@ private function loadCachedVersionFieldDefinitionsPerLanguage(
      *
      * @return \Ibexa\Contracts\Core\Persistence\Content\ContentInfo
      */
-    public function extractContentInfoFromRow(array $row, $prefix = '', $treePrefix = 'ezcontentobject_tree_')
-    {
+    public function extractContentInfoFromRow(
+        array $row,
+        $prefix = '',
+        $treePrefix = 'ezcontentobject_tree_'
+    ) {
         $contentInfo = new ContentInfo();
         $contentInfo->id = (int)$row["{$prefix}id"];
         $contentInfo->name = (string)$row["{$prefix}name"];
         $contentInfo->contentTypeId = (int)$row["{$prefix}contentclass_id"];
+        $contentInfo->contentTypeIdentifier = (string)$row['content_type_identifier'];
         $contentInfo->sectionId = (int)$row["{$prefix}section_id"];
         $contentInfo->currentVersionNo = (int)$row["{$prefix}current_version"];
         $contentInfo->ownerId = (int)$row["{$prefix}owner_id"];

src/lib/Search/Legacy/Content/Gateway/DoctrineDatabase.php

@@ -12,6 +12,7 @@
 use Doctrine\DBAL\Query\QueryBuilder;
 use Ibexa\Contracts\Core\Persistence\Content\ContentInfo;
 use Ibexa\Contracts\Core\Persistence\Content\Language\Handler as LanguageHandler;
+use Ibexa\Contracts\Core\Persistence\Content\Type;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 use Ibexa\Core\Persistence\Legacy\Content\Gateway as ContentGateway;
@@ -216,8 +217,9 @@ private function getContentInfoList(
         array $languageFilter
     ): array {
         $query = $this->connection->createQueryBuilder();
+        $expr = $query->expr();
         $query->select(
-            'DISTINCT c.*, main_tree.main_node_id AS main_tree_main_node_id',
+            'DISTINCT c.*, main_tree.main_node_id AS main_tree_main_node_id, ct.identifier AS content_type_identifier',
         );
 
         if ($sort !== null) {
@@ -236,10 +238,19 @@ private function getContentInfoList(
                 'c',
                 LocationGateway::CONTENT_TREE_TABLE,
                 'main_tree',
-                $query->expr()->andX(
+                $expr->and(
                     'main_tree.contentobject_id = c.id',
                     'main_tree.main_node_id = main_tree.node_id'
                 )
+            )
+            ->innerJoin(
+                'c',
+                'ezcontentclass',
+                'ct',
+                $expr->and(
+                    $expr->eq('c.contentclass_id', 'ct.id'),
+                    $expr->eq('ct.version', Type::STATUS_DEFINED)
+                )
             );
 
         if ($sort !== null) {

tests/lib/Event/AbstractServiceTest.php

@@ -15,11 +15,14 @@
 
 abstract class AbstractServiceTest extends TestCase
 {
-    public function getEventDispatcher(string $beforeEventName, string $eventName): TraceableEventDispatcher
+    public function getEventDispatcher(string $beforeEventName, ?string $eventName): TraceableEventDispatcher
     {
         $eventDispatcher = new EventDispatcher();
         $eventDispatcher->addListener($beforeEventName, static function (BeforeEvent $event) {});
-        $eventDispatcher->addListener($eventName, static function (AfterEvent $event) {});
+        if ($eventName !== null) {
+            $eventDispatcher->addListener($eventName, static function (AfterEvent $event) {
+            });
+        }
 
         return new TraceableEventDispatcher(
             $eventDispatcher,