Use Pimcore AdminUserTranslator for Editable Dialog Box (#222)

Author: solverat

UPGRADE.md

@@ -1,5 +1,8 @@
 # Upgrade Notes
 
+## 5.1.1
+- [BUGFIX] Use Pimcore AdminUserTranslator in BrickConfigBuilder [#219](https://github.com/dachcom-digital/pimcore-toolbox/issues/219)
+
 ## 5.1.0
 - [NEW FEATURE] Add `property_normalizer.default_type_mapping` feature
 - [ENHANCEMENT] Respect thumbnail config in normalizer

config/core_areas/parallaxContainer_service.yaml

@@ -2,7 +2,7 @@ services:
     ToolboxBundle\Document\ToolboxAreabrick\ParallaxContainer\ParallaxContainer:
         parent: ToolboxBundle\Document\Areabrick\AbstractAreabrick
         arguments:
-            - '@translator'
+            - '@Pimcore\Bundle\AdminBundle\Translation\AdminUserTranslator'
             - '@pimcore.templating.engine.delegating'
         tags:
             - { name: toolbox.area.brick, id: parallaxContainer }

config/services/editable.yaml

@@ -6,18 +6,25 @@ services:
         public: true
 
     ToolboxBundle\Builder\BrickConfigBuilderInterface: '@ToolboxBundle\Builder\BrickConfigBuilder'
-    ToolboxBundle\Builder\BrickConfigBuilder: ~
+    ToolboxBundle\Builder\BrickConfigBuilder:
+        arguments:
+            $translator: '@Pimcore\Bundle\AdminBundle\Translation\AdminUserTranslator'
 
     ToolboxBundle\Builder\InlineConfigBuilderInterface: '@ToolboxBundle\Builder\InlineConfigBuilder'
     ToolboxBundle\Builder\InlineConfigBuilder:
+        arguments:
+            $translator: '@Pimcore\Bundle\AdminBundle\Translation\AdminUserTranslator'
         calls:
             - [ setHeadlessEditableRenderer, [ '@ToolboxBundle\Document\Editable\HeadlessEditableRenderer' ] ]
             - [ setHeadlessEditableInfoFactory, [ '@ToolboxBundle\Factory\HeadlessEditableInfoFactory' ] ]
 
     ToolboxBundle\Document\Editable\EditableWorker:
         public: true
 
-    ToolboxBundle\Document\Editable\ConfigParser: ~
+    ToolboxBundle\Document\Editable\ConfigParser:
+        arguments:
+            $translator: '@Pimcore\Bundle\AdminBundle\Translation\AdminUserTranslator'
+
     ToolboxBundle\Document\Editable\HeadlessEditableRenderer: ~
 
     ToolboxBundle\Factory\HeadlessEditableInfoFactory: ~

src/Builder/AbstractConfigBuilder.php

@@ -4,15 +4,15 @@
 
 use Pimcore\Model\Document\Editable\Area\Info;
 use Pimcore\Templating\Renderer\EditableRenderer;
-use Pimcore\Translation\Translator;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use ToolboxBundle\Document\Editable\ConfigParser;
 use ToolboxBundle\Manager\AreaManagerInterface;
 use Twig\Environment;
 
 abstract class AbstractConfigBuilder
 {
     public function __construct(
-        protected Translator $translator,
+        protected TranslatorInterface $translator,
         protected Environment $templating,
         protected AreaManagerInterface $areaManager,
         protected ConfigParser $configParser,

src/Document/Areabrick/AbstractAreabrick.php

@@ -7,8 +7,6 @@
 use Pimcore\Model\Document;
 use ToolboxBundle\Builder\BrickConfigBuilderInterface;
 use ToolboxBundle\Document\Response\HeadlessResponse;
-use ToolboxBundle\Event\HeadlessEditableActionEvent;
-use ToolboxBundle\ToolboxEvents;
 
 abstract class AbstractAreabrick extends AbstractBaseAreabrick implements EditableDialogBoxInterface
 {

src/Document/Editable/ConfigParser.php

@@ -5,13 +5,13 @@
 use Pimcore\Model\Document\Editable\Area\Info;
 use Pimcore\Model\Document\Editable\Checkbox;
 use Pimcore\Templating\Renderer\EditableRenderer;
-use Pimcore\Translation\Translator;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use ToolboxBundle\Registry\StoreProviderRegistryInterface;
 
 class ConfigParser
 {
     public function __construct(
-        protected Translator $translator,
+        protected TranslatorInterface $translator,
         protected StoreProviderRegistryInterface $storeProvider,
         protected EditableRenderer $editableRenderer
     ) {

src/Document/ToolboxAreabrick/ParallaxContainer/ParallaxContainer.php

@@ -5,15 +5,15 @@
 use Pimcore\Model\Asset;
 use Pimcore\Model\Document\Editable;
 use Pimcore\Model\Element\ElementInterface;
-use Pimcore\Translation\Translator;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Templating\EngineInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use ToolboxBundle\Document\Areabrick\AbstractAreabrick;
 
 class ParallaxContainer extends AbstractAreabrick
 {
     public function __construct(
-        private Translator $translator,
+        private TranslatorInterface $translator,
         private EngineInterface $templating
     ) {
     }

src/Service/DownloadInfoService.php

@@ -3,16 +3,16 @@
 namespace ToolboxBundle\Service;
 
 use Pimcore\Model\Asset;
+use Symfony\Contracts\Translation\TranslatorInterface;
 use ToolboxBundle\Connector\BundleConnector;
-use Pimcore\Translation\Translator;
 use ToolboxBundle\Manager\ConfigManagerInterface;
 
 class DownloadInfoService
 {
     public function __construct(
         protected ConfigManagerInterface $configManager,
         protected BundleConnector $bundleConnector,
-        protected Translator $translator
+        protected TranslatorInterface $translator
     ) {
     }
 
@@ -44,7 +44,7 @@ public function getDownloadInfo(
         }
 
         $dType = pathinfo($download->getFilename(), PATHINFO_EXTENSION);
-        $downloadTitle = $showFileNameIfTitleEmpty ? $download->getFilename() : $this->translator->trans('Download', [], 'admin');
+        $downloadTitle = $showFileNameIfTitleEmpty ? $download->getFilename() : $this->translator->trans('Download');
         $dName = ($download->getMetadata('title')) ?: $downloadTitle;
         $dAltText = $download->getMetadata('alt') ?: '';
         $dImageAltText = !empty($dAltText) ? $dAltText : $dName;

tests/UnitDefault/Areas/AbstractAreaTest.php

@@ -11,7 +11,6 @@
 use Symfony\Component\HttpFoundation\Request;
 use ToolboxBundle\Builder\BrickConfigBuilder;
 use ToolboxBundle\Manager\ConfigManager;
-use ToolboxBundle\Manager\ConfigManagerInterface;
 
 abstract class AbstractAreaTest extends BundleTestCase
 {