feat(translation): added API to fetch all translation strings for given language (#3317)

Author: thorsten

phpmyfaq/src/api-routes.php

@@ -42,6 +42,7 @@
 use phpMyFAQ\Controller\Frontend\FaqController as FaqFrontendController;
 use phpMyFAQ\Controller\Frontend\QuestionController as QuestionFrontendController;
 use phpMyFAQ\Controller\Frontend\RegistrationController as RegistrationFrontendController;
+use phpMyFAQ\Controller\Frontend\TranslationController;
 use phpMyFAQ\Controller\Frontend\UnauthorizedUserController;
 use phpMyFAQ\Controller\Frontend\UserController;
 use phpMyFAQ\Controller\Frontend\VotingController;
@@ -252,6 +253,11 @@
         'controller' => [RegistrationFrontendController::class, 'create'],
         'methods' => 'POST'
     ],
+    'api.private.translations' => [
+        'path' => 'translations/{language}',
+        'controller' => [TranslationController::class, 'translations'],
+        'methods' => 'POST'
+    ],
     'api.private.user.password' => [
         'path' => 'user/password/update',
         'controller' => [UnauthorizedUserController::class, 'updatePassword'],

phpmyfaq/src/phpMyFAQ/Controller/Frontend/TranslationController.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * The Translations Controller
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * @package   phpMyFAQ
+ * @author    Thorsten Rinne <thorsten@phpmyfaq.de>
+ * @copyright 2025 phpMyFAQ Team
+ * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ * @link      https://www.phpmyfaq.de
+ * @since     2025-03-17
+ */
+
+namespace phpMyFAQ\Controller\Frontend;
+
+use phpMyFAQ\Controller\AbstractController;
+use phpMyFAQ\Core\Exception;
+use phpMyFAQ\Filter;
+use phpMyFAQ\Language;
+use phpMyFAQ\Translation;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+class TranslationController extends AbstractController
+{
+    #[Route('api/translations/{language}', name: 'api.private.translations', methods: ['GET'])]
+    public function translations(Request $request): JsonResponse
+    {
+        $language = Filter::filterVar($request->get('language'), FILTER_SANITIZE_SPECIAL_CHARS);
+
+        if (!Language::isASupportedLanguage($language)) {
+            return $this->json(['error' => 'Language not supported'], Response::HTTP_BAD_REQUEST);
+        }
+
+        try {
+            Translation::getInstance()->setCurrentLanguage($language);
+            return $this->json(Translation::getAll());
+        } catch (Exception $e) {
+            return $this->json(['error' => $e->getMessage()], Response::HTTP_INTERNAL_SERVER_ERROR);
+        }
+    }
+}

phpmyfaq/src/phpMyFAQ/Controller/Frontend/UserController.php

@@ -22,7 +22,6 @@
 use phpMyFAQ\Filter;
 use phpMyFAQ\Session\Token;
 use phpMyFAQ\Translation;
-use phpMyFAQ\User\CurrentUser;
 use phpMyFAQ\User\TwoFactor;
 use RobThree\Auth\TwoFactorAuthException;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -36,7 +35,7 @@ class UserController extends AbstractController
     /**
      * @throws \Exception
      */
-    #[Route('api/user/data/update', methods: ['PUT'])]
+    #[Route('api/user/data/update', name: 'api.private.user.update', methods: ['PUT'])]
     public function updateData(Request $request): JsonResponse
     {
         $this->userIsAuthenticated();

phpmyfaq/src/phpMyFAQ/Translation.php

@@ -75,6 +75,19 @@ public static function get(string $languageKey): string|array|null
         return null;
     }
 
+    /**
+     * Returns all translations from the current language.
+     * @throws Exception
+     * @return array<string, string>
+     */
+    public static function getAll(): array
+    {
+        self::$translation->checkInit();
+        self::$translation->checkLanguageLoaded();
+
+        return self::$translation->loadedLanguages[self::$translation->currentLanguage];
+    }
+
     /**
      * @throws Exception
      */