refactor: migrated report page to controller (#3257)

thorsten · Nov 30, 2024 · a939f4d · a939f4d
1 parent c4cbff7
commit a939f4d
Show file tree

Hide file tree

Showing 9 changed files with 179 additions and 206 deletions.
diff --git a/phpmyfaq/admin/header.php b/phpmyfaq/admin/header.php
@@ -127,7 +127,12 @@
     'msgAdminElasticsearchStats',
     'statistics/search'
 );
-$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry('reports', 'reports', 'ad_menu_reports');
+$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry(
+    'reports',
+    'reports',
+    'ad_menu_reports',
+    'statistics/report'
+);
 
 $secLevelEntries['imports_exports'] = $adminHelper->addMenuEntry(
     PermissionType::FAQ_ADD->value,
@@ -170,11 +175,6 @@
 $secLevelEntries['config'] .= $adminHelper->addMenuEntry('editconfig', 'system', 'ad_system_info', 'system');
 
 switch ($action) {
-    case 'user':
-    case 'group':
-    case 'cookies':
-        $userPage = true;
-        break;
     case 'category-overview':
     case 'addcategory':
     case 'savecategory':
@@ -206,28 +206,6 @@
     case 'stickyfaqs':
         $contentPage = true;
         break;
-    case 'statistics':
-    case 'viewsessions':
-    case 'sessionbrowse':
-    case 'adminlog':
-    case 'searchstats':
-    case 'reports':
-    case 'reportview':
-        $statisticsPage = true;
-        break;
-    case 'export':
-    case 'importcsv':
-        $exportsPage = true;
-        break;
-    case 'backup':
-        $backupPage = true;
-        break;
-    case 'config':
-    case 'stopwordsconfig':
-    case 'upgrade':
-    case 'instances':
-    case 'system':
-    case 'elasticsearch':
     case 'forms':
         $configurationPage = true;
         break;

diff --git a/phpmyfaq/admin/index.php b/phpmyfaq/admin/index.php
@@ -314,11 +314,6 @@
             case 'glossary':
                 require 'glossary.php';
                 break;
-            // Reports
-            case 'reportview':
-            case 'reports':
-                require 'report.main.php';
-                break;
             // Config administration
             case 'forms':
                 require 'forms.php';

diff --git a/phpmyfaq/admin/report.main.php b/phpmyfaq/admin/report.main.php
diff --git a/phpmyfaq/assets/templates/admin/statistics/report.main.twig b/phpmyfaq/assets/templates/admin/statistics/report.main.twig
diff --git a/phpmyfaq/assets/templates/admin/statistics/report.twig b/phpmyfaq/assets/templates/admin/statistics/report.twig
@@ -0,0 +1,112 @@
+{% extends '@admin/index.twig' %}
+
+{% block content %}
+  <form action="#" id="pmf-admin-report-form" method="post" accept-charset="utf-8">
+    {{ csrfTokenInput | raw }}
+    <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-filetype-csv"></i> {{ 'ad_menu_reports' | translate }}
+      </h1>
+      <div class="btn-toolbar mb-2 mb-md-0">
+        <div class="btn-group mr-2">
+          <button id="pmf-admin-create-report" class="btn btn-outline-primary" type="button">
+            {{ 'ad_stat_report_make_report' | translate }}
+          </button>
+        </div>
+      </div>
+    </div>
+
+    <div class="container-fluid">
+      <div class="row mb-2">
+        <h4>{{ 'ad_stat_report_fields' | translate }}</h4>
+      </div>
+      <div class="row g-3">
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="category" name="category"
+                 value="1" checked>
+          <label class="form-check-label" for="category">
+            {{ 'ad_stat_report_category' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="sub_category" name="sub_category"
+                 value="1" checked>
+          <label class="form-check-label" for="sub_category">
+            {{ 'ad_stat_report_sub_category' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="translations"
+                 name="translations" value="1" checked>
+          <label class="form-check-label" for="translations">
+            {{ 'ad_stat_report_translations' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="language" name="language"
+                 value="1" checked>
+          <label class="form-check-label" for="language">
+            {{ 'ad_stat_report_language' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="id" name="id" value="1" checked>
+          <label class="form-check-label" for="id">
+            {{ 'ad_stat_report_id' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="sticky" name="sticky" value="1"
+                 checked>
+          <label class="form-check-label" for="sticky">
+            {{ 'ad_stat_report_sticky' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="title" name="title" value="1"
+                 checked>
+          <label class="form-check-label" for="title">
+            {{ 'ad_stat_report_title' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="creation_date"
+                 name="creation_date" value="1" checked>
+          <label class="form-check-label" for="creation_date">
+            {{ 'ad_stat_report_creation_date' | translate }}
+          </label>
+        </div>
+
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="owner" name="owner" value="1"
+                 checked>
+          <label class="form-check-label" for="owner">
+            {{ 'ad_stat_report_owner' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="last_modified_person"
+                 name="last_modified_person" value="1" checked>
+          <label class="form-check-label" for="last_modified_person">
+            {{ 'ad_stat_report_last_modified_person' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="url" name="url" value="1" checked>
+          <label class="form-check-label" for="url">
+            {{ 'ad_stat_report_url' | translate }}
+          </label>
+        </div>
+        <div class="col form-check">
+          <input class="form-check-input" type="checkbox" id="visits" name="visits" value="1"
+                 checked>
+          <label class="form-check-label" for="visits">
+            {{ 'ad_stat_report_visits' | translate }}
+          </label>
+        </div>
+      </div>
+
+    </div>
+  </form>
+{% endblock %}
diff --git a/phpmyfaq/src/admin-routes.php b/phpmyfaq/src/admin-routes.php
@@ -26,6 +26,7 @@
 use phpMyFAQ\Controller\Administration\InstanceController;
 use phpMyFAQ\Controller\Administration\PasswordChangeController;
 use phpMyFAQ\Controller\Administration\RatingController;
+use phpMyFAQ\Controller\Administration\ReportController;
 use phpMyFAQ\Controller\Administration\SessionKeepAliveController;
 use phpMyFAQ\Controller\Administration\StatisticsSearchController;
 use phpMyFAQ\Controller\Administration\StatisticsSessionsController;
@@ -159,6 +160,11 @@
         'controller' => [RatingController::class, 'index'],
         'methods' => 'GET'
     ],
+    'admin.statistics.report' => [
+        'path' => '/statistics/report',
+        'controller' => [ReportController::class, 'index'],
+        'methods' => 'GET'
+    ],
     'admin.statistics.search' => [
         'path' => '/statistics/search',
         'controller' => [StatisticsSearchController::class, 'index'],

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Administration/AbstractAdministrationController.php b/phpmyfaq/src/phpMyFAQ/Controller/Administration/AbstractAdministrationController.php
@@ -236,11 +236,6 @@ protected function getHeader(Request $request): array
             case 'stickyfaqs':
                 $contentPage = true;
                 break;
-            case 'searchstats':
-            case 'reports':
-            case 'reportview':
-                $statisticsPage = true;
-                break;
             case 'forms':
                 $configurationPage = true;
                 break;
@@ -269,6 +264,7 @@ protected function getHeader(Request $request): array
                 break;
             case 'admin.statistics.admin-log':
             case 'admin.statistics.ratings':
+            case 'admin.statistics.report':
             case 'admin.statistics.sessions':
             case 'admin.statistics.session.day':
             case 'admin.statistics.session.id':

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/ExportController.php b/phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/ExportController.php
@@ -162,7 +162,7 @@ public function exportReport(Request $request): Response
 
         $handle = fopen('php://temp', 'r+');
         foreach ($text as $row) {
-            fputcsv($handle, $row);
+            fputcsv($handle, $row, ',', '"', '\\', PHP_EOL);
         }
 
         rewind($handle);