refactor config array to public Config service

guavestudios · Jul 11, 2023 · 83a628b · 83a628b
1 parent 51bbcc2
commit 83a628b
Show file tree

Hide file tree

Showing 8 changed files with 320 additions and 43 deletions.
diff --git a/src/Api/DeeplApi.php b/src/Api/DeeplApi.php
@@ -4,6 +4,7 @@
 
 namespace Guave\DeeplBundle\Api;
 
+use Guave\DeeplBundle\Config\Config;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
@@ -14,10 +15,10 @@ class DeeplApi
 {
     protected string $apiKey;
 
-    public function __construct(string $deeplApiKey, bool $freeApi = false)
+    public function __construct(string $deeplApiKey, Config $config)
     {
         $url = 'https://api.deepl.com';
-        if ($freeApi) {
+        if ($config->isFreeApi()) {
             $url = 'https://api-free.deepl.com';
         }
 

diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Guave\DeeplBundle\Config;
+
+class Config
+{
+    private bool $enabled = false;
+
+    private bool $freeApi = false;
+
+    private string $defaultLanguage = 'de';
+
+    private array $tables = [];
+
+    public function __construct(array $config)
+    {
+        if (isset($config['enabled'])) {
+            $this->setEnabled($config['enabled']);
+        }
+        if (isset($config['freeApi'])) {
+            $this->setFreeApi($config['freeApi']);
+        }
+        if (isset($config['defaultLanguage'])) {
+            $this->setDefaultLanguage($config['defaultLanguage']);
+        }
+        if (isset($config['tables'])) {
+            $this->setTables($config['tables']);
+        }
+    }
+
+    public function isEnabled(): bool
+    {
+        return $this->enabled;
+    }
+
+    public function setEnabled(bool $enabled): void
+    {
+        $this->enabled = $enabled;
+    }
+
+    public function isFreeApi(): bool
+    {
+        return $this->freeApi;
+    }
+
+    public function setFreeApi(bool $freeApi): void
+    {
+        $this->freeApi = $freeApi;
+    }
+
+    public function getDefaultLanguage(): string
+    {
+        return $this->defaultLanguage;
+    }
+
+    public function setDefaultLanguage(string $defaultLanguage): void
+    {
+        $this->defaultLanguage = $defaultLanguage;
+    }
+
+    public function getTables(): array
+    {
+        return $this->tables;
+    }
+
+    public function setTables(array $tables): void
+    {
+        $this->tables = $tables;
+    }
+
+    public function getDeeplConfigByTable(string $table): array
+    {
+        $tables = $this->getTables();
+
+        return $tables[$table] ?? [];
+    }
+}
diff --git a/src/Controller/Backend/DeeplButtons.php b/src/Controller/Backend/DeeplButtons.php
@@ -8,23 +8,21 @@
 use Contao\Controller;
 use Contao\DataContainer;
 use Contao\Image;
+use Guave\DeeplBundle\Config\Config;
 use Guave\DeeplBundle\Resolver\ActiveLanguageResolverInterface;
 
 class DeeplButtons extends Backend
 {
-    protected string $defaultLanguage;
-
-    protected array $tables;
+    protected iterable $activeLanguageResolver;
 
     protected string $activeLang;
 
-    protected iterable $activeLanguageResolver;
+    protected Config $config;
 
-    public function __construct(string $defaultLanguage, array $tables, iterable $activeLanguageResolver)
+    public function __construct(Config $config, iterable $activeLanguageResolver)
     {
-        $this->defaultLanguage = $defaultLanguage;
-        $this->tables = $tables;
         $this->activeLanguageResolver = $activeLanguageResolver;
+        $this->config = $config;
 
         parent::__construct();
     }
@@ -36,19 +34,19 @@ public function registerDeepl(DataContainer $dc)
         }
 
         $activeLang = $this->getActiveLang($dc);
-        if ($activeLang === $this->defaultLanguage) {
+        if ($activeLang === $this->config->getDefaultLanguage()) {
             return;
         }
 
         Controller::loadLanguageFile('modules');
 
         $GLOBALS['TL_JAVASCRIPT'][] = 'bundles/guavedeepl/assets/translate.js';
 
-        foreach ($this->tables[$dc->table]['fields'] as $field) {
+        foreach ($this->config->getTables()[$dc->table]['fields'] as $field) {
             $GLOBALS['TL_DCA'][$dc->table]['fields'][$field]['xlabel'][] = [self::class, 'translateButton'];
         }
 
-        foreach ($this->tables[$dc->table]['multiColumnFields'] as $field => $fields) {
+        foreach ($this->config->getTables()[$dc->table]['multiColumnFields'] as $field => $fields) {
             $GLOBALS['TL_DCA'][$dc->table]['fields'][$field]['xlabel'][] = [self::class, 'translateMultiColumnButton'];
         }
 
@@ -70,7 +68,7 @@ public function translateMultiColumnButton(DataContainer $dc)
     {
         $field = $dc->field;
 
-        return $this->getMulticolumnTranslateButton($field, $this->tables[$dc->table]['multiColumnFields'][$field]['fields']);
+        return $this->getMulticolumnTranslateButton($field, $this->config->getTables()[$dc->table]['multiColumnFields'][$field]['fields']);
     }
 
     public function addTranslateAllButton($arrButtons)
@@ -80,7 +78,7 @@ public function addTranslateAllButton($arrButtons)
             $this->activeLang,
             sprintf(
                 $GLOBALS['TL_LANG']['guave_deepl']['translateAll'][0],
-                $this->defaultLanguage,
+                $this->config->getDefaultLanguage(),
                 $this->activeLang,
                 Image::getHtml('pasteinto.svg')
             )
@@ -97,7 +95,7 @@ public function getTranslateButton(string $field): string
             $this->activeLang,
             sprintf(
                 $GLOBALS['TL_LANG']['guave_deepl']['translate'][0],
-                $this->defaultLanguage,
+                $this->config->getDefaultLanguage(),
                 $this->activeLang,
                 Image::getHtml('pasteinto.svg')
             )
@@ -113,7 +111,7 @@ public function getMulticolumnTranslateButton(string $field, array $fields): str
             $this->activeLang,
             sprintf(
                 $GLOBALS['TL_LANG']['guave_deepl']['translate'][0],
-                $this->defaultLanguage,
+                $this->config->getDefaultLanguage(),
                 $this->activeLang,
                 Image::getHtml('pasteinto.svg')
             )
@@ -134,7 +132,7 @@ protected function getActiveLang(DataContainer $dc): string
         }
 
         if (!$language) {
-            $language = $this->defaultLanguage;
+            $language = $this->config->getDefaultLanguage();
         }
 
         $this->activeLang = $language;

diff --git a/src/DependencyInjection/GuaveDeeplExtension.php b/src/DependencyInjection/GuaveDeeplExtension.php
@@ -5,6 +5,7 @@
 namespace Guave\DeeplBundle\DependencyInjection;
 
 use Guave\DeeplBundle\Api\DeeplApi;
+use Guave\DeeplBundle\Config\Config;
 use Guave\DeeplBundle\Controller\Backend\DeeplButtons;
 use Guave\DeeplBundle\EventListener\LoadDataContainerListener;
 use Guave\DeeplBundle\EventListener\LoadFallbackTranslationsListener;
@@ -23,19 +24,7 @@ public function loadInternal(array $mergedConfig, ContainerBuilder $container):
         );
         $loader->load('services.yml');
 
-        $definition = $container->getDefinition(LoadDataContainerListener::class);
-
-        $definition->setArgument(0, $mergedConfig['enabled']);
-        $definition->setArgument(1, $mergedConfig['tables']);
-
-        $definition2 = $container->getDefinition(DeeplButtons::class);
-        $definition2->setArgument(0, $mergedConfig['defaultLanguage']);
-        $definition2->setArgument(1, $mergedConfig['tables']);
-
-        $definition3 = $container->getDefinition(LoadFallbackTranslationsListener::class);
-        $definition3->setArgument(0, $mergedConfig['defaultLanguage']);
-
-        $definition4 = $container->getDefinition(DeeplApi::class);
-        $definition4->setArgument(1, $mergedConfig['freeApi']);
+        $configDefinition = $container->getDefinition(Config::class);
+        $configDefinition->setArgument(0, $mergedConfig);
     }
 }
diff --git a/src/EventListener/LoadDataContainerListener.php b/src/EventListener/LoadDataContainerListener.php
@@ -6,25 +6,24 @@
 
 use Contao\CoreBundle\ServiceAnnotation\Hook;
 use Contao\Input;
+use Guave\DeeplBundle\Config\Config;
 use Guave\DeeplBundle\Controller\Backend\DeeplButtons;
 
 /**
  * @Hook("loadDataContainer")
  */
 class LoadDataContainerListener
 {
-    protected bool $enabled = false;
-    protected array $tables;
+    protected Config $config;
 
-    public function __construct(bool $enabled, array $tables)
+    public function __construct(Config $config)
     {
-        $this->enabled = $enabled;
-        $this->tables = $tables;
+        $this->config = $config;
     }
 
     public function __invoke(string $table): void
     {
-        if (!$this->enabled) {
+        if (!$this->config->isEnabled()) {
             return;
         }
 
@@ -52,7 +51,7 @@ public function __invoke(string $table): void
             return;
         }
 
-        if (array_key_exists($table, $this->tables)) {
+        if (array_key_exists($table, $this->config->getTables())) {
             $GLOBALS['TL_DCA'][$table]['config']['onload_callback'][] = [DeeplButtons::class, 'registerDeepl'];
 
             // register fallback translation

diff --git a/src/EventListener/LoadFallbackTranslationsListener.php b/src/EventListener/LoadFallbackTranslationsListener.php
@@ -8,6 +8,7 @@
 use Contao\DataContainer;
 use Contao\Model;
 use DC_Multilingual;
+use Guave\DeeplBundle\Config\Config;
 use Guave\DeeplBundle\Model\MultilingualModel;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
@@ -18,13 +19,13 @@ class LoadFallbackTranslationsListener
 {
     protected SessionInterface $session;
 
-    protected string $defaultLanguage;
+    protected Config $config;
 
     public function __construct(
-        string $defaultLanguage,
+        Config $config,
         SessionInterface $session
     ) {
-        $this->defaultLanguage = $defaultLanguage;
+        $this->config = $config;
         $this->session = $session;
     }
 
@@ -40,7 +41,7 @@ public function loadFallbackTranslation(DataContainer $dc)
 
         $id = (int) $dc->id;
         $activeLang = $this->getActiveLang($dc->table, $id);
-        if ($activeLang === $this->defaultLanguage) {
+        if ($activeLang === $this->config->getDefaultLanguage()) {
             return;
         }
 
@@ -87,7 +88,7 @@ protected function getActiveLang(string $table, int $id): string
         $sessionKey = 'dc_multilingual:' . $table . ':' . $id;
 
 
-        return $objSessionBag->get($sessionKey) ?? $this->defaultLanguage;
+        return $objSessionBag->get($sessionKey) ?? $this->config->getDefaultLanguage();
     }
 
     protected function getModel(string $table, int $id): ?Model

diff --git a/src/Resources/config/services.yml b/src/Resources/config/services.yml
@@ -27,3 +27,9 @@ services:
         public: true
         tags:
             - { name: 'deepl.resolver', priority: 19 }
+
+    Guave\DeeplBundle\Config\Config:
+        public: true
+
+    Guave\DeeplBundle\Translate\TranslateDCA:
+        public: true