AUT-3675: make translation with new prefix

actions/class.RdfController.php

@@ -55,6 +55,7 @@
 use oat\generis\model\resource\Contract\ResourceDeleterInterface;
 use oat\tao\model\metadata\exception\InconsistencyConfigException;
 use oat\tao\model\resources\Exception\PartialClassDeletionException;
+use oat\tao\helpers\MapLabelNameService;
 
 /**
  * The TaoModule is an abstract controller,
@@ -467,7 +468,8 @@ public function editClassLabel()
             $this->setData('reload', true);
         }
 
-        $this->setData('formTitle', __('Edit class %s', \tao_helpers_Display::htmlize($class->getLabel())));
+        $getLabel = MapLabelNameService::mapLabelName($class->getLabel());
+        $this->setData('formTitle', __('Edit class %s', tao_helpers_Display::htmlize($getLabel)));
         $this->setData('myForm', $myForm->render());
         $this->setView('form.tpl', 'tao');
     }

actions/form/class.Instance.php

@@ -25,6 +25,7 @@
 use oat\generis\model\OntologyAwareTrait;
 use oat\generis\model\OntologyRdfs;
 use oat\oatbox\service\ServiceManager;
+use oat\tao\helpers\Layout;
 use oat\tao\helpers\form\ElementMapFactory;
 use oat\tao\helpers\form\elements\ElementValue;
 use oat\tao\model\form\DataProvider\FormDataProviderInterface;
@@ -45,6 +46,7 @@ class tao_actions_form_Instance extends tao_actions_form_Generis
 
     public const EXCLUDED_PROPERTIES = 'excludedProperties';
 
+    public const LANG_PREFIX = '-S';
     /**
      * Initialize the form
      *
@@ -91,6 +93,7 @@ protected function initElements()
         } catch (common_exception_Error $exception) {
             $language = DEFAULT_LANG;
         }
+        $language = $this->checkPrefix($language);
 
         $topClass = $this->getTopClazz();
 
@@ -227,4 +230,42 @@ private function isEmptyLabel($element): bool
         return $element instanceof tao_helpers_form_elements_Label
             && empty($element->getRawValue());
     }
+
+    /**
+     * Check if the Solar design is enabled and the prefix has not yet been added
+     *
+     */
+    private function isContainPrefix(string $language): bool
+    {
+        $pattern = '/' . self::LANG_PREFIX . '$/';
+
+
+        return !Layout::isSolarDesignEnabled() || preg_match($pattern, $language, $matches);
+    }
+
+    /**
+     * Concatenate prefix for Solar design translations
+     *
+     */
+    private function addPrefix(string $language): string
+    {
+        return $language . self::LANG_PREFIX;
+    }
+
+    /**
+     * Check and Add prefix for Solar design translations
+     *
+     */
+    private function checkPrefix(string $language): string
+    {
+        if (!$this->isContainPrefix($language)) {
+            $localesDir = 'views/locales';
+            $dir = dirname(__FILE__) . '/../../' . $localesDir . '/' . $this->addPrefix($language);
+            if (is_dir($dir)) {
+                $language = $this->addPrefix($language);
+            }
+        }
+
+        return $language;
+    }
 }

helpers/LayoutHelper.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA;
+ *
+ *
+ */
+
+namespace oat\tao\helpers;
+
+class LayoutHelper
+{
+    public function isSolarDesignEnabled(): bool
+    {
+        return Layout::isSolarDesignEnabled();
+    }
+}

helpers/ServiceProvider/HelperServiceProvider.php

@@ -15,7 +15,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2023 (original work) Open Assessment Technologies SA.
+ * Copyright (c) 2023-2024 (original work) Open Assessment Technologies SA.
  *
  * @author Andrei Shapiro <andrei.shapiro@taotesting.com>
  */
@@ -26,6 +26,8 @@
 
 use oat\generis\model\DependencyInjection\ContainerServiceProviderInterface;
 use oat\tao\helpers\dateFormatter\DateFormatterFactory;
+use oat\tao\helpers\LayoutHelper;
+use oat\tao\helpers\translation\SolarThemeFileHelper;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use tao_helpers_Mode;
 
@@ -38,5 +40,16 @@ public function __invoke(ContainerConfigurator $configurator): void
         $services->set(DateFormatterFactory::class, DateFormatterFactory::class);
 
         $services->set(tao_helpers_Mode::class, tao_helpers_Mode::class);
+
+        $services->set(LayoutHelper::class, LayoutHelper::class);
+
+        $services
+            ->set(SolarThemeFileHelper::class, SolarThemeFileHelper::class)
+            ->public()
+            ->args(
+                [
+                    service(LayoutHelper::class)
+                ]
+            );
     }
 }

helpers/class.Display.php

@@ -204,4 +204,5 @@ private static function getApplicationService(): ApplicationService
         /** @noinspection PhpIncompatibleReturnTypeInspection */
         return ServiceManager::getServiceManager()->get(ApplicationService::SERVICE_ID);
     }
+
 }

helpers/class.I18n.php

@@ -24,6 +24,7 @@
  */
 
 use oat\generis\model\OntologyRdf;
+use oat\tao\helpers\Layout;
 
 /**
  * Internationalization helper.
@@ -40,6 +41,12 @@ class tao_helpers_I18n
      */
     public const AVAILABLE_LANGS_CACHEKEY = 'i18n_available_langs';
 
+    /**
+     * locale prefix for New theme
+     *
+     */
+    public const LANG_PREFIX = '-S';
+
     /**
      * Short description of attribute availableLangs
      *
@@ -60,6 +67,7 @@ public static function init(common_ext_Extension $extension, ?string $langCode):
         if (empty($langCode)) {
             throw new Exception("Language is not defined");
         }
+        $langCode = self::checkPrefix($langCode);
 
         //init the ClearFw l10n tools
         $translations = tao_models_classes_LanguageService::singleton()->getServerBundle($langCode);
@@ -78,7 +86,7 @@ public static function init(common_ext_Extension $extension, ?string $langCode):
      */
     public static function getLangCode()
     {
-        return common_session_SessionManager::getSession()->getInterfaceLanguage();
+        return self::checkPrefix(common_session_SessionManager::getSession()->getInterfaceLanguage());
     }
 
     /**
@@ -193,4 +201,41 @@ public static function getAvailableLangsByUsage(core_kernel_classes_Resource $us
         }
         return $returnValue;
     }
+
+    /**
+     * Check if the Solar design is enabled and the prefix has not yet been added
+     *
+     */
+    private static function isContainPrefix(string $language): bool
+    {
+        $pattern = '/' . self::LANG_PREFIX . '$/';
+
+        return !Layout::isSolarDesignEnabled() || preg_match($pattern, $language, $matches);
+    }
+
+    /**
+     * Concatenate prefix for Solar design translations
+     *
+     */
+    private static function addPrefix(string $language): string
+    {
+        return $language . self::LANG_PREFIX;
+    }
+
+    /**
+     * Check and Add prefix for Solar design translations
+     *
+     */
+    private static function checkPrefix(string $language): string
+    {
+        if (!self::isContainPrefix($language)) {
+            $localesDir = 'views/locales';
+            $dir = dirname(__FILE__) . '/../' . $localesDir . '/' . self::addPrefix($language);
+            if (is_dir($dir)) {
+                $language = self::addPrefix($language);
+            }
+        }
+
+        return $language;
+    }
 }

helpers/mapLabelNameService.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+ namespace oat\tao\helpers;
+ use oat\tao\helpers\Layout;
+
+ class MapLabelNameService
+{
+
+    private const ITEM = 'Item';
+    private const MEDIA = 'Media';
+    private const DELIVERY = 'Delivery';
+    private const ASSETS = 'Assets';
+
+    // New terms for isSolarDesignEnabled FF
+    private $mapLabelNames = [
+        self::ITEM => 'Item',
+        self::MEDIA => 'Asset',
+        self::DELIVERY => 'Delivery',
+        self::ASSETS => 'Asset'
+    ];
+
+    /**
+    * @param $labelName
+    * @return string
+    */
+    public function mapLabelName(string $labelName): string
+    {
+        $mapName = $labelName;
+        if (Layout::isSolarDesignEnabled()) {
+            $mapName = __(self::$mapLabelNames[$labelName]);
+        }
+        return $mapName;
+    }
+}

helpers/translation/AbstractSolarThemeHelper.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers\translation;
+
+use oat\tao\helpers\LayoutHelper;
+
+abstract class AbstractSolarThemeHelper
+{
+    public const LANG_PREFIX = '-S';
+
+    private LayoutHelper $layoutHelper;
+
+    public function __construct(
+        LayoutHelper $layoutHelper
+    ) {
+        $this->layoutHelper = $layoutHelper;
+    }
+
+    /**
+     * Check if the Solar design is enabled and the prefix has not yet been added
+     *
+     */
+    public function isContainPrefix(string $language): bool
+    {
+        $pattern = '/' . self::LANG_PREFIX . '$/';
+
+        return !$this->layoutHelper->isSolarDesignEnabled() || preg_match($pattern, $language, $matches);
+    }
+
+    /**
+     * Concatenate prefix for Solar design translations
+     *
+     */
+    protected function addPrefix(string $language): string
+    {
+        return $language . self::LANG_PREFIX;
+    }
+
+    /**
+     * Check and add prefix for Solar design translations
+     *
+     */
+    abstract public function checkPrefix(string $language): string;
+}

helpers/translation/SolarThemeFileHelper.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers\translation;
+
+class SolarThemeFileHelper extends AbstractSolarThemeHelper
+{
+    /**
+     * Check and add prefix for Solar design translations
+     *
+     */
+    public function checkPrefix(string $language): string
+    {
+        if (!$this->isContainPrefix($language)) {
+            $localesDir = 'views/locales';
+            $dir = dirname(__FILE__) . '/../../' . $localesDir . '/' . $this->addPrefix($language);
+            if (is_dir($dir)) {
+                $language = $this->addPrefix($language);
+            }
+        }
+
+        return $language;
+    }
+}