refactor: moved Translation class as Twig extension to simplify code

phpmyfaq/admin/category.add.php

@@ -52,7 +52,7 @@
         'faqLangCode' => $faqLangCode,
         'parentId' => $parentId,
         'ad_categ_new' => Translation::get('ad_categ_new'),
-        'ad_categ_show' => Translation::get('ad_categ_show'),
+        'msgCategoryMatrix' => Translation::get('msgCategoryMatrix'),
         'userOptions' => $userHelper->getAllUserOptions(),
         'ad_categ_title' => Translation::get('ad_categ_titel'),
         'ad_categ_owner' => Translation::get('ad_categ_owner'),

phpmyfaq/admin/category.main.php

@@ -54,7 +54,7 @@
 
 if ($currentUser->perm->hasPermission($currentUser->getUserId(), PermissionType::CATEGORY_EDIT->value)) {
     $templateVars = [
-        'msgHeaderCategoryMain' => Translation::get('ad_menu_categ_edit'),
+        'msgHeaderCategoryMain' => Translation::get('msgHeaderCategoryOverview'),
     ];
 
     // Save a new category

phpmyfaq/admin/category.overview.php

@@ -20,9 +20,7 @@
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Session\Token;
 use phpMyFAQ\Template\TwigWrapper;
-use phpMyFAQ\Translation;
 use Symfony\Component\HttpFoundation\Request;
-use phpMyFAQ\Template\TranslateTwigExtension;
 
 if (!defined('IS_VALID_PHPMYFAQ')) {
     http_response_code(400);
@@ -46,17 +44,12 @@
 }
 
 $twig = new TwigWrapper(PMF_ROOT_DIR . '/assets/templates');
-$twig->addExtension(new TranslateTwigExtension());
 $template = $twig->loadTemplate('./admin/content/category.overview.twig');
 
 $templateVars = [
-    'msgHeaderCategoryOverview' => Translation::get('ad_menu_categ_edit'),
-    'msgAddCategory' => Translation::get('ad_kateg_add'),
-    'msgCategoryMatrix' => Translation::get('ad_categ_show'),
     'csrfTokenInput' => Token::getInstance()->getTokenInput('category'),
     'categoryTree' => $categoryTree,
     'categoryInfo' => $categoryInfo,
-    'msgCategoryRemark' => Translation::get('ad_categ_remark'),
 ];
 
 echo $template->render($templateVars);

phpmyfaq/admin/category.showstructure.php

@@ -113,12 +113,12 @@
         'categoryTree' => $category->getCategoryTree(),
         'basePath' => $request->getBasePath(),
         'faqlangcode' => $faqLangCode,
-        'ad_categ_remark_overview' => Translation::get('ad_categ_remark_overview'),
+        'msgCategoryRemark_overview' => Translation::get('msgCategoryRemark_overview'),
         'ad_categ_title' => Translation::get('ad_categ_titel'),
         'ad_categ_translate' => Translation::get('ad_categ_translate'),
         'ad_menu_categ_structure' => Translation::get('ad_menu_categ_structure'),
-        'ad_kateg_add' => Translation::get('ad_kateg_add'),
-        'ad_menu_categ_edit' => Translation::get('ad_menu_categ_edit'),
+        'msgAddCategory' => Translation::get('msgAddCategory'),
+        'msgHeaderCategoryOverview' => Translation::get('msgHeaderCategoryOverview'),
         'msgCategory' => Translation::get('msgCategory'),
         'translations' => $translations,
         'ad_categ_translated' => Translation::get('ad_categ_translated')

phpmyfaq/admin/header.php

@@ -62,7 +62,7 @@
 $secLevelEntries['content'] = $adminHelper->addMenuEntry(
     'addcateg+editcateg+delcateg',
     'category-overview',
-    'ad_menu_categ_edit',
+    'msgHeaderCategoryOverview',
     $action
 );
 $secLevelEntries['content'] .= $adminHelper->addMenuEntry(

phpmyfaq/assets/templates/admin/content/category.add.twig

@@ -5,7 +5,7 @@
   <div class="btn-toolbar mb-2 mb-md-0">
     <div class="btn-group mr-2">
       <a class="btn btn-sm btn-info" href="?action=showcategory">
-        <i aria-hidden="true" class="bi bi-list"></i> {{ ad_categ_show }}
+        <i aria-hidden="true" class="bi bi-list"></i> {{ msgCategoryMatrix }}
       </a>
     </div>
   </div>

phpmyfaq/assets/templates/admin/content/category.overview.twig

@@ -1,14 +1,14 @@
 <div class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center pt-3 pb-2 mb-3 border-bottom">
   <h1 class="h2">
-    <i aria-hidden="true" class="bi bi-folder"></i> {{ msgHeaderCategoryOverview }}
+    <i aria-hidden="true" class="bi bi-folder"></i> {{ 'msgHeaderCategoryOverview' | translate }}
   </h1>
   <div class="btn-toolbar mb-2 mb-md-0">
     <div class="btn-group mr-2">
       <a class="btn btn-outline-success" href="?action=addcategory" id="addCategoryModal">
-        <i aria-hidden="true" class="bi bi-plus"></i> {{ msgAddCategory }}
+        <i aria-hidden="true" class="bi bi-plus"></i> {{ 'msgAddCategory' | translate }}
       </a>
       <a class="btn btn-outline-info" href="?action=showcategory">
-        <i aria-hidden="true" class="bi bi-list"></i> {{ msgCategoryMatrix }}
+        <i aria-hidden="true" class="bi bi-list"></i> {{ 'msgCategoryMatrix' | translate }}
       </a>
     </div>
   </div>
@@ -28,7 +28,7 @@
 <div class="row mt-4">
   <div class="col">
     <div class="alert alert-info">
-      {{ msgCategoryRemark }}
+      {{ 'msgCategoryRemark' | translate }}
     </div>
   </div>
 </div>

phpmyfaq/assets/templates/admin/content/category.showstructure.twig

@@ -6,10 +6,10 @@
   <div class="btn-toolbar mb-2 mb-md-0">
     <div class="btn-group mr-2">
       <a class="btn btn-outline-success" href="?action=addcategory">
-        <i aria-hidden="true" class="bi bi-folder-plus"></i> {{ ad_kateg_add }}
+        <i aria-hidden="true" class="bi bi-folder-plus"></i> {{ msgAddCategory }}
       </a>
       <a class="btn btn-outline-info" href="?action=category-overview">
-        <i aria-hidden="true" class="bi bi-list"></i> {{ ad_menu_categ_edit }}
+        <i aria-hidden="true" class="bi bi-list"></i> {{ msgHeaderCategoryOverview }}
       </a>
     </div>
   </div>

phpmyfaq/assets/templates/default/bookmarks.twig

@@ -3,31 +3,27 @@
 {% block content %}
 <div class="row g-5">
   <div class="col-md-12">
-    <h2 class="pb-4 mb-4 border-bottom">{{ msgMyBookmarks }}</h2>
+    <h2 class="pb-4 mb-4 border-bottom">{{ 'msgMyBookmarks' | translate }}</h2>
 
     <div class="accordion" id="bookmarkAccordion">
       {% set count = 1 %}
       {% for bookmark in bookmarksList %}
-        <!--<a href="{{ bookmark['url'] }}" class="list-group-item list-group-item-action" id="delete-bookmark-{{ bookmark['id'] }}">
-          <div class="d-flex w-100 justify-content-between">
-            <h5 class="mb-1">{{ bookmark['title'] }}</h5>
-              <i class="bi bi-trash text-danger m-1 pmf-delete-bookmark" title="{{ removeBookmark }}"
-                 data-bs-toggle="tooltip" data-bs-placement="top" data-pmf-bookmark-id="{{ bookmark['id'] }}"></i>
-          </div>
-        </a>-->
         <div class="accordion-item shadow-sm rounded mb-3 border-1" id="delete-bookmark-{{ bookmark['id'] }}">
           <h2 class="accordion-header" id="heading{{ count }}">
-            <button class="accordion-button d-flex collapsed justify-content-between" type="button" data-bs-toggle="collapse" data-bs-target="#collapse{{ count }}" aria-expanded="true" aria-controls="collapse{{ count }}">
+            <button class="accordion-button d-flex collapsed justify-content-between" type="button"
+                    data-bs-toggle="collapse" data-bs-target="#collapse{{ count }}" aria-expanded="true"
+                    aria-controls="collapse{{ count }}">
               <span class="flex-grow-1 text-start">{{ count }}. {{ bookmark['title'] }}</span>
-              <i class="bi bi-trash text-danger m-1 pmf-delete-bookmark" title="{{ removeBookmark }}"
-                data-bs-toggle="tooltip" data-bs-placement="top" data-pmf-bookmark-id="{{ bookmark['id'] }}" data-pmf-csrf="{{ csrfTokenDeleteBookmark }}">
+              <i class="bi bi-trash text-danger m-1 pmf-delete-bookmark" title="{{ 'removeBookmark' | translate }}"
+                 data-bs-toggle="tooltip" data-bs-placement="top" data-pmf-bookmark-id="{{ bookmark['id'] }}"
+                 data-pmf-csrf="{{ csrfTokenDeleteBookmark }}">
               </i>&nbsp;
             </button>
           </h2>
           <div id="collapse{{ count }}" class="accordion-collapse collapse" aria-labelledby="heading{{ count }}" data-bs-parent="#bookmarkAccordion">
             <div class="accordion-body">
               {{ bookmark['answer']|raw }}
-              <a href="{{ bookmark['url'] }}">{{ msgLinkToFAQ }}</a>
+              <a href="{{ bookmark['url'] }}">{{ 'msgLinkToFAQ' | translate }}</a>
             </div>
           </div>
         </div>

phpmyfaq/bookmarks.php

@@ -18,7 +18,6 @@
 
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Template\TwigWrapper;
-use phpMyFAQ\Translation;
 use phpMyFAQ\Bookmark;
 use phpMyFAQ\User\CurrentUser;
 use phpMyFAQ\Session\Token;
@@ -39,10 +38,7 @@
 // Twig template variables
 $templateVars = [
     ... $templateVars,
-    'msgMyBookmarks' => Translation::get('msgMyBookmarks'),
     'bookmarksList' => $bookmark->getBookmarkList(),
-    'removeBookmark' => Translation::get('removeBookmark'),
-    'msgLinkToFAQ' => Translation::get('msgLinkToFAQ'),
     'csrfTokenDeleteBookmark' => Token::getInstance()->getTokenString('delete-bookmark')
 ];
 

phpmyfaq/contact.php

@@ -49,6 +49,7 @@
 // Twig template variables
 $templateVars = [
     ... $templateVars,
+    'title' => Translation::get('msgContact'),
     'pageHeader' => Translation::get('msgContact'),
     'msgContactOwnText' => $contactText,
     'msgContactEMail' => Translation::get('msgContactEMail'),

phpmyfaq/src/phpMyFAQ/Controller/AbstractController.php

@@ -24,7 +24,6 @@
 use phpMyFAQ\Enums\PermissionType;
 use phpMyFAQ\Filter;
 use phpMyFAQ\Template\TemplateException;
-use phpMyFAQ\Template\TranslateTwigExtension;
 use phpMyFAQ\Template\TwigWrapper;
 use phpMyFAQ\User\CurrentUser;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -71,8 +70,6 @@ public function render(string $pathToTwigFile, array $templateVars = [], Respons
     {
         $response ??= new Response();
         $twigWrapper = new TwigWrapper(PMF_ROOT_DIR . '/assets/templates');
-        $twigWrapper->addExtension(new DebugExtension());
-        $twigWrapper->addExtension(new TranslateTwigExtension());
         $template = $twigWrapper->loadTemplate($pathToTwigFile);
 
         $response->setContent($template->render($templateVars));

phpmyfaq/src/phpMyFAQ/Template/TwigWrapper.php

@@ -46,6 +46,11 @@ public function __construct(string $templatePath)
                 'debug' => System::isDevelopmentVersion()
             ]
         );
+
+        // Always add the translation extension
+        $this->twigEnvironment->addExtension(new TranslateTwigExtension());
+
+        // If we're on a development version or debug is enabled, add the debug extension
         if (System::isDevelopmentVersion() || DEBUG) {
             $this->twigEnvironment->addExtension(new DebugExtension());
         }

phpmyfaq/startpage.php

@@ -21,7 +21,6 @@
 use phpMyFAQ\Language\Plurals;
 use phpMyFAQ\News;
 use phpMyFAQ\Strings;
-use phpMyFAQ\Template\TranslateTwigExtension;
 use phpMyFAQ\Template\TwigWrapper;
 use phpMyFAQ\Translation;
 use Symfony\Component\HttpFoundation\Request;
@@ -52,7 +51,6 @@
 $param = $faqConfig->get('records.orderingPopularFaqs') == 'visits' ? 'visits' : 'voted';
 
 $twig = new TwigWrapper(PMF_ROOT_DIR . '/assets/templates/' . TwigWrapper::getTemplateSetName());
-$twig->addExtension(new TranslateTwigExtension());
 $twigTemplate = $twig->loadTemplate('./startpage.twig');
 
 // Twig template variables

phpmyfaq/translations/language_ar.php

@@ -131,7 +131,7 @@
 $PMF_LANG['ad_menu_entry_aprove'] = 'إعتماد أسئلة';
 $PMF_LANG['ad_menu_entry_edit'] = 'تحرير أسئلة';
 $PMF_LANG['ad_menu_categ_add'] = 'إضافة تصنيف';
-$PMF_LANG['ad_menu_categ_edit'] = 'إدارة التصنيفات';
+$PMF_LANG['msgHeaderCategoryOverview'] = 'إدارة التصنيفات';
 $PMF_LANG['ad_menu_news_add'] = 'إضافة خبر';
 $PMF_LANG['ad_menu_news_edit'] = 'تحرير خبر';
 $PMF_LANG['ad_menu_open'] = 'تحرير اسئلة مفتوحة';
@@ -241,7 +241,7 @@
 $PMF_LANG['ad_categ_delete'] = 'حذف';
 $PMF_LANG['ad_categ_updatecateg'] = 'تحديث التصنيف';
 $PMF_LANG['ad_categ_nodata'] = 'لا يوجد بيانات بعد';
-$PMF_LANG['ad_categ_remark'] = '';
+$PMF_LANG['msgCategoryRemark'] = '';
 $PMF_LANG['ad_categ_edit_1'] = 'تحرير';
 $PMF_LANG['ad_categ_edit_2'] = 'التصنيف';
 $PMF_LANG['ad_categ_added'] = 'تمت عملية إضافة التصنيف بنجاح .';
@@ -353,7 +353,7 @@
 $PMF_LANG['ad_news_edit'] = 'تحرير خبر';
 $PMF_LANG['ad_cookie'] = 'الكوكيز';
 $PMF_LANG['ad_sess_head'] = 'عرض الجلسات';
-$PMF_LANG['ad_kateg_add'] = 'إضافة تصنيف';
+$PMF_LANG['msgAddCategory'] = 'إضافة تصنيف';
 $PMF_LANG['ad_kateg_rename'] = 'إعادة تسمية';
 $PMF_LANG['ad_adminlog_date'] = 'التاريخ';
 $PMF_LANG['ad_adminlog_user'] = 'المستخدم';
@@ -592,7 +592,7 @@
 $PMF_LANG['ad_categ_deletealllang'] = 'احذف لكل اللغات ؟';
 $PMF_LANG['ad_categ_deletethislang'] = 'احذف في هذة اللغة فقط ؟';
 $PMF_LANG['ad_categ_translated'] = 'التصنيف تم ترجمته';
-$PMF_LANG['ad_categ_show'] = 'الخلاصة';
+$PMF_LANG['msgCategoryMatrix'] = 'الخلاصة';
 $PMF_LANG['ad_menu_categ_structure'] = 'ملخص عن التصنيف يتضمن اللغات';
 $PMF_LANG['ad_entry_userpermission'] = 'صلاحيات المستخدم :';
 $PMF_LANG['ad_entry_grouppermission'] = 'صلاحيات المجموعة :';
@@ -734,8 +734,8 @@
 $LANG_CONF['search.enableRelevance'] = array('checkbox', 'Activate relevance support? (default: disabled)');
 $PMF_LANG['ad_entry_intlink'] = 'Select a FAQ record to insert it as a link...';
 $PMF_LANG['ad_categ_paste2'] = 'لصق بعد';
-$PMF_LANG['ad_categ_remark_move'] = 'The exchange of 2 categories is only possible at the same level.';
-$PMF_LANG['ad_categ_remark_overview'] = 'The correct order of categories will be shown, if all categories are defined for the actual language (first column).';
+$PMF_LANG['msgCategoryRemark_move'] = 'The exchange of 2 categories is only possible at the same level.';
+$PMF_LANG['msgCategoryRemark_overview'] = 'The correct order of categories will be shown, if all categories are defined for the actual language (first column).';
 $PMF_LANG['msgUsersOnline'] = '%d ضيوف و %d اعضاء مسجلين';
 $PMF_LANG['ad_adminlog_del_older_30d'] = 'Delete immediately logs older than 30 days';
 $PMF_LANG['ad_adminlog_delete_success'] = 'Older logs successfully deleted.';

phpmyfaq/translations/language_bn.php

@@ -157,7 +157,7 @@
 $PMF_LANG["ad_menu_entry_aprove"] = "Approve FAQs";
 $PMF_LANG["ad_menu_entry_edit"] = "Edit FAQs";
 $PMF_LANG["ad_menu_categ_add"] = "Add Entity";
-$PMF_LANG["ad_menu_categ_edit"] = "Edit Entity";
+$PMF_LANG["msgHeaderCategoryOverview"] = "Edit Entity";
 $PMF_LANG["ad_menu_news_add"] = "Add News";
 $PMF_LANG["ad_menu_news_edit"] = "Edit News";
 $PMF_LANG["ad_menu_open"] = "Open questions";
@@ -284,7 +284,7 @@
 $PMF_LANG["ad_categ_delete"] = "delete";
 $PMF_LANG["ad_categ_updatecateg"] = "Update Entity";
 $PMF_LANG["ad_categ_nodata"] = "No data found in database";
-$PMF_LANG["ad_categ_remark"] = "Please note that existing entries will not be visible anymore, if you delete the category. You must assign a new category for the article or delete the article.";
+$PMF_LANG["msgCategoryRemark"] = "Please note that existing entries will not be visible anymore, if you delete the category. You must assign a new category for the article or delete the article.";
 $PMF_LANG["ad_categ_edit_1"] = "Edit";
 $PMF_LANG["ad_categ_edit_2"] = "Entity";
 $PMF_LANG["ad_categ_add"] = "add Entity";
@@ -423,9 +423,9 @@
 $PMF_LANG["ad_sess_head"] = "View sessions";
 
 // Added v1.1 - 06.01.2002 - Bastian
-$PMF_LANG["ad_menu_categ_edit"] = "Categories";
+$PMF_LANG["msgHeaderCategoryOverview"] = "Categories";
 $PMF_LANG["ad_menu_stat"] = "Rating Statistics";
-$PMF_LANG["ad_kateg_add"] = "add main Entity";
+$PMF_LANG["msgAddCategory"] = "add main Entity";
 $PMF_LANG["ad_kateg_rename"] = "Rename";
 $PMF_LANG["ad_adminlog_date"] = "Date";
 $PMF_LANG["ad_adminlog_user"] = "User";
@@ -736,7 +736,7 @@
 $PMF_LANG["ad_categ_translated"] = "The category has been translated.";
 
 // added v2.0.0 - 2006-09-21 by Rudi
-$PMF_LANG["ad_categ_show"] = "Overview";
+$PMF_LANG["msgCategoryMatrix"] = "Overview";
 $PMF_LANG['ad_menu_categ_structure'] = "Entity Overview including its languages";
 
 // added v2.0.0 - 2006-09-26 by Thorsten
@@ -756,8 +756,8 @@
 
 //added 2.0.0 - 2006-10-10 by Rudi
 $PMF_LANG["ad_categ_paste2"] = "Paste after";
-$PMF_LANG["ad_categ_remark_move"] = "The exchange of 2 categories is only possible at the same level.";
-$PMF_LANG["ad_categ_remark_overview"] = "The correct order of categories will be shown, if all categories are defined for the actual language (first column).";
+$PMF_LANG["msgCategoryRemark_move"] = "The exchange of 2 categories is only possible at the same level.";
+$PMF_LANG["msgCategoryRemark_overview"] = "The correct order of categories will be shown, if all categories are defined for the actual language (first column).";
 
 // added v2.0.0 - 2006-10-15 by Matteo
 $PMF_LANG['msgUsersOnline'] = ' ও %d জন অতিথি অনলাইনে';

phpmyfaq/translations/language_bs.php

@@ -163,7 +163,7 @@
 $PMF_LANG["ad_menu_entry_aprove"] = "Potvrdi Unose";
 $PMF_LANG["ad_menu_entry_edit"] = "Izmeni Unose";
 $PMF_LANG["ad_menu_categ_add"] = "Dodaj Kategoriju";
-$PMF_LANG["ad_menu_categ_edit"] = "Izmeni Kategoriju";
+$PMF_LANG["msgHeaderCategoryOverview"] = "Izmeni Kategoriju";
 $PMF_LANG["ad_menu_news_add"] = "Dodaj Novosti";
 $PMF_LANG["ad_menu_news_edit"] = "Izmena Novosti";
 $PMF_LANG["ad_menu_open"] = "Izmeni otvorena pitanja";
@@ -289,7 +289,7 @@
 $PMF_LANG["ad_categ_delete"] = "Obriši";
 $PMF_LANG["ad_categ_updatecateg"] = "Izmeni Kategoriju";
 $PMF_LANG["ad_categ_nodata"] = "Podaci nisu pronađeni u bazi";
-$PMF_LANG["ad_categ_remark"] = "Ako obrišete kategoriju, članci u njoj više neće biti dostupni. Moraćete dodeliti novu kategoriju, ili obrisati unose.";
+$PMF_LANG["msgCategoryRemark"] = "Ako obrišete kategoriju, članci u njoj više neće biti dostupni. Moraćete dodeliti novu kategoriju, ili obrisati unose.";
 $PMF_LANG["ad_categ_edit_1"] = "Izmeni";
 $PMF_LANG["ad_categ_edit_2"] = "Kategorija";
 $PMF_LANG["ad_categ_add"] = "Dodaj Kategoriju";
@@ -428,9 +428,9 @@
 $PMF_LANG["ad_sess_head"] = "Pregled sesija";
 
 // Added v1.1 - 06.01.2002 - Bastian
-$PMF_LANG["ad_menu_categ_edit"] = "Administracija Kategorija";
+$PMF_LANG["msgHeaderCategoryOverview"] = "Administracija Kategorija";
 $PMF_LANG["ad_menu_stat"] = "Statistike (rejting)";
-$PMF_LANG["ad_kateg_add"] = "Dodaj Kategoriju";
+$PMF_LANG["msgAddCategory"] = "Dodaj Kategoriju";
 $PMF_LANG["ad_kateg_rename"] = "Promeni Ime";
 $PMF_LANG["ad_adminlog_date"] = "Datum";
 $PMF_LANG["ad_adminlog_user"] = "Korisnik";
@@ -736,7 +736,7 @@
 $PMF_LANG["ad_categ_translated"] = "Kategorija je prevedena.";
 
 // added v2.0.0 - 2006-09-21 by Rudi
-$PMF_LANG["ad_categ_show"] = "Pregled";
+$PMF_LANG["msgCategoryMatrix"] = "Pregled";
 $PMF_LANG['ad_menu_categ_structure'] = "Pregled kategorije uključujući svoje jezike";
 
 // added v2.0.0 - 2006-09-26 by Thorsten
@@ -756,8 +756,8 @@
 
 //added 2.0.0 - 2006-10-10 by Rudi
 $PMF_LANG["ad_categ_paste2"] = "Nalepi iza";
-$PMF_LANG["ad_categ_remark_move"] = "Razmena 2 kategorije je moguća samo na istom nivou.";
-$PMF_LANG["ad_categ_remark_overview"] = "Tačan red kategorija če biti prikazan, ako su sve kategorije definisane za određeni jezik (prva kolona).";
+$PMF_LANG["msgCategoryRemark_move"] = "Razmena 2 kategorije je moguća samo na istom nivou.";
+$PMF_LANG["msgCategoryRemark_overview"] = "Tačan red kategorija če biti prikazan, ako su sve kategorije definisane za određeni jezik (prva kolona).";
 
 // added v2.0.0 - 2006-10-15 by Matteo
 $PMF_LANG['msgUsersOnline'] = '%d Gostiju i %d Registrovanih';