[FEATURE] Add Event for Glossary detection

web-vision · Dec 17, 2024 · ec04cb0 · ec04cb0
1 parent 8f0b2a9
commit ec04cb0
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 23 deletions.
diff --git a/Classes/Domain/Dto/CurrentPage.php b/Classes/Domain/Dto/CurrentPage.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebVision\Deepltranslate\Core\Domain\Dto;
+
+use WebVision\Deepltranslate\Core\Event\GlossaryKeyEvent;
+use WebVision\Deepltranslate\Core\Exception\MissingParameterException;
+
+/**
+ * This class holds the current working page
+ * while processing inside the DataHandler
+ *
+ * It is the main entry point for extensions during events
+ * detecting the right page,
+ * for example, while detecting a glossary.
+ *
+ * @see GlossaryKeyEvent for a usage example
+ */
+final class CurrentPage
+{
+    public function __construct(
+        public readonly int $uid,
+        public readonly string $title
+    ) {
+    }
+
+    /**
+     * @throws MissingParameterException
+     */
+    public static function fromArray(array $record): self
+    {
+        if (!array_key_exists('uid', $record) || !array_key_exists('title', $record)) {
+            throw new MissingParameterException(
+                'Missing parameters in creating CurrentPage Domain Transfer Object',
+                1734445433
+            );
+        }
+        return new self((int)$record['uid'], $record['title']);
+    }
+}
diff --git a/Classes/Event/GlossaryKeyEvent.php b/Classes/Event/GlossaryKeyEvent.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebVision\Deepltranslate\Core\Event;
+
+use WebVision\Deepltranslate\Core\Domain\Dto\CurrentPage;
+
+final class GlossaryKeyEvent
+{
+    private ?string $glossaryId = null;
+
+    public function __construct(
+        private readonly string $sourceLanguage,
+        private readonly string $targetLanguage,
+        private readonly ?CurrentPage $currentPage
+    ) {
+    }
+
+    public function setGlossaryId(string $glossaryId): void
+    {
+        $this->glossaryId = $glossaryId;
+    }
+
+    public function getGlossaryId(): ?string
+    {
+        return $this->glossaryId;
+    }
+
+    public function getSourceLanguage(): string
+    {
+        return $this->sourceLanguage;
+    }
+
+    public function getTargetLanguage(): string
+    {
+        return $this->targetLanguage;
+    }
+
+    public function getCurrentPage(): ?CurrentPage
+    {
+        return $this->currentPage;
+    }
+}
diff --git a/Classes/Exception/MissingParameterException.php b/Classes/Exception/MissingParameterException.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WebVision\Deepltranslate\Core\Exception;
+
+final class MissingParameterException extends \Exception
+{
+}
diff --git a/Classes/Service/DeeplService.php b/Classes/Service/DeeplService.php
@@ -8,18 +8,17 @@
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
+use TYPO3\CMS\Core\EventDispatcher\EventDispatcher;
 use WebVision\Deepltranslate\Core\ClientInterface;
 use WebVision\Deepltranslate\Core\Domain\Dto\TranslateContext;
-use WebVision\Deepltranslate\Core\Domain\Repository\GlossaryRepository;
+use WebVision\Deepltranslate\Core\Event\GlossaryKeyEvent;
 use WebVision\Deepltranslate\Core\Exception\ApiKeyNotSetException;
 use WebVision\Deepltranslate\Core\Utility\DeeplBackendUtility;
 
 final class DeeplService implements LoggerAwareInterface
 {
     use LoggerAwareTrait;
 
-    protected GlossaryRepository $glossaryRepository;
-
     private FrontendInterface $cache;
 
     private ClientInterface $client;
@@ -28,12 +27,11 @@ final class DeeplService implements LoggerAwareInterface
     public function __construct(
         FrontendInterface $cache,
         ClientInterface $client,
-        GlossaryRepository $glossaryRepository,
-        ProcessingInstruction $processingInstruction
+        ProcessingInstruction $processingInstruction,
+        private readonly EventDispatcher $eventDispatcher
     ) {
         $this->cache = $cache;
         $this->client = $client;
-        $this->glossaryRepository = $glossaryRepository;
         $this->processingInstruction = $processingInstruction;
     }
 
@@ -69,14 +67,16 @@ public function translateContent(TranslateContext $translateContext): string
         }
         // If the source language is set to Autodetect, no glossary can be detected.
         if ($translateContext->getSourceLanguageCode() !== null) {
-            // @todo Make glossary findable by current site.
-            $glossary = $this->glossaryRepository->getGlossaryBySourceAndTarget(
+            /** @var GlossaryKeyEvent $glossaryEvent */
+            $glossaryEvent = $this->eventDispatcher->dispatch(new GlossaryKeyEvent(
                 $translateContext->getSourceLanguageCode(),
                 $translateContext->getTargetLanguageCode(),
                 DeeplBackendUtility::detectCurrentPage($this->processingInstruction)
-            );
-
-            $translateContext->setGlossaryId($glossary['glossary_id']);
+            ));
+            $glossaryId = $glossaryEvent->getGlossaryId();
+            if ($glossaryId !== null) {
+                $translateContext->setGlossaryId($glossaryId);
+            }
         }
 
         try {

diff --git a/Classes/Utility/DeeplBackendUtility.php b/Classes/Utility/DeeplBackendUtility.php
@@ -20,11 +20,13 @@
 use TYPO3\CMS\Core\Utility\MathUtility;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 use WebVision\Deepltranslate\Core\Configuration;
+use WebVision\Deepltranslate\Core\Domain\Dto\CurrentPage;
 use WebVision\Deepltranslate\Core\Exception\LanguageIsoCodeNotFoundException;
 use WebVision\Deepltranslate\Core\Exception\LanguageRecordNotFoundException;
 use WebVision\Deepltranslate\Core\Service\IconOverlayGenerator;
 use WebVision\Deepltranslate\Core\Service\LanguageService;
 use WebVision\Deepltranslate\Core\Service\ProcessingInstruction;
+use WebVision\Deepltranslate\Core\Domain\Dto\CurrentPage;
 
 // @todo Make class final. Overriding a static utility class does not make much sense, but better to enforce it.
 class DeeplBackendUtility
@@ -33,10 +35,7 @@ class DeeplBackendUtility
 
     private static bool $configurationLoaded = false;
 
-    /**
-     * @var array{uid: int, title: string}|array<empty>
-     */
-    protected static array $currentPage;
+    protected static ?CurrentPage $currentPage = null;
 
     /**
      * @return string
@@ -238,15 +237,10 @@ private static function getBackendUserAuthentication(): BackendUserAuthenticatio
         return $GLOBALS['BE_USER'];
     }
 
-    /**
-     * @return array{uid: int, title: string}|array<empty>
-     */
-    public static function detectCurrentPage(ProcessingInstruction $processingInstruction): array
+    public static function detectCurrentPage(ProcessingInstruction $processingInstruction): ?CurrentPage
     {
-        self::$currentPage = [];
-
         if ($processingInstruction->getProcessingTable() === 'pages') {
-            self::$currentPage = self::getPageRecord((int)$processingInstruction->getProcessingId());
+            self::$currentPage = CurrentPage::fromArray(self::getPageRecord((int)$processingInstruction->getProcessingId()));
         } elseif (
             $processingInstruction->getProcessingTable() !== null
             && strlen($processingInstruction->getProcessingTable()) > 0
@@ -256,7 +250,7 @@ public static function detectCurrentPage(ProcessingInstruction $processingInstru
                 (string)$processingInstruction->getProcessingTable(),
                 (int)$processingInstruction->getProcessingId()
             );
-            self::$currentPage = self::getPageRecord($pageId);
+            self::$currentPage = CurrentPage::fromArray(self::getPageRecord($pageId));
         }
 
         return self::$currentPage;