refactor: migrated sitemap page (#3834)

Author: thorsten

phpmyfaq/index.php

@@ -121,31 +121,27 @@
 // Try Symfony Router first
 //
 try {
-    // Load routes
     $routes = require __DIR__ . '/src/public-routes.php';
 
-    // Create URL matcher
     $context = new RequestContext();
     $context->fromRequest($request);
     $matcher = new UrlMatcher($routes, $context);
 
-    // Try to match the current route
     $parameters = $matcher->match($request->getPathInfo());
 
-    // Extract controller and method
     $controllerCallable = $parameters['_controller'];
     unset($parameters['_controller'], $parameters['_route'], $parameters['_methods']);
 
-    // Instantiate controller and call method
+    $request->attributes->add($matcher->match($request->getPathInfo()));
+
     if (is_array($controllerCallable)) {
         [$controllerClass, $method] = $controllerCallable;
         $controller = new $controllerClass();
-        $routeResponse = $controller->$method($request, ...$parameters);
+        $routeResponse = $controller->$method($request);
     } else {
-        $routeResponse = $controllerCallable($request, ...$parameters);
+        $routeResponse = $controllerCallable($request);
     }
 
-    // Send response and exit
     $routeResponse->send();
     exit();
 } catch (ResourceNotFoundException $e) {

phpmyfaq/sitemap.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Contact Controller
+ * Overview 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

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

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * Sitemap 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    Thomas Zeithaml <[email protected]>
+ *  @author    Thorsten Rinne <[email protected]>
+ *  @copyright 2005-2026 phpMyFAQ Team
+ *  @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ *  @link      https://www.phpmyfaq.de
+ *  @since     2005-08-21
+ */
+
+namespace phpMyFAQ\Controller\Frontend;
+
+use phpMyFAQ\Core\Exception;
+use phpMyFAQ\Filter;
+use phpMyFAQ\Strings;
+use phpMyFAQ\Translation;
+use phpMyFAQ\User\CurrentUser;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Twig\Error\LoaderError;
+
+class SitemapController extends AbstractFrontController
+{
+    /**
+     * @throws Exception
+     * @throws LoaderError
+     * @throws \Exception
+     */ #[Route(path: '/sitemap/{letter}/{language}.html', name: 'public.sitemap')]
+    public function index(Request $request): Response
+    {
+        $faqSession = $this->container->get('phpmyfaq.user.session');
+        $faqSession->setCurrentUser($this->currentUser);
+        $faqSession->userTracking('sitemap', 0);
+
+        $letter = Filter::filterVar($request->attributes->get('letter'), FILTER_SANITIZE_SPECIAL_CHARS);
+        if (!is_null($letter) && 1 == Strings::strlen($letter)) {
+            $currLetter = strtoupper(Strings::substr($letter, 0, 1));
+        } else {
+            $currLetter = '';
+        }
+
+        [$currentUser, $currentGroups] = CurrentUser::getCurrentUserGroupId($this->currentUser);
+
+        $siteMap = $this->container->get('phpmyfaq.sitemap');
+        $siteMap->setUser($currentUser);
+        $siteMap->setGroups($currentGroups);
+
+        return $this->render('sitemap.twig', [
+            ...$this->getHeader($request),
+            'title' => sprintf('%s - %s', Translation::get(key: 'msgSitemap'), $this->configuration->getTitle()),
+            'metaDescription' => sprintf(Translation::get(key: 'msgSitemapMetaDesc'), $this->configuration->getTitle()),
+            'pageHeader' =>
+                $currLetter === '' || $currLetter === '0' ? Translation::get(key: 'msgSitemap') : $currLetter,
+            'letters' => $siteMap->getAllFirstLetters(),
+            'faqs' => $siteMap->getFaqsFromLetter($currLetter),
+            'writeCurrentLetter' =>
+                $currLetter === '' || $currLetter === '0' ? Translation::get(key: 'msgSitemap') : $currLetter,
+        ]);
+    }
+}

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

@@ -19,7 +19,9 @@
 
 use phpMyFAQ\Controller\Frontend\Api\SetupController;
 use phpMyFAQ\Controller\Frontend\ContactController;
-use phpMyFAQ\Controller\Frontend\OverviewController;use phpMyFAQ\Controller\Frontend\PageNotFoundController;
+use phpMyFAQ\Controller\Frontend\OverviewController;
+use phpMyFAQ\Controller\Frontend\PageNotFoundController;
+use phpMyFAQ\Controller\Frontend\SitemapController as FrontendSitemapController;
 use phpMyFAQ\Controller\Frontend\WebAuthnController;
 use phpMyFAQ\Controller\LlmsController;
 use phpMyFAQ\Controller\RobotsController;
@@ -40,6 +42,11 @@
         'controller' => [OverviewController::class, 'index'],
         'methods' => 'GET',
     ],
+    'public.sitemap' => [
+        'path' => '/sitemap/{letter}/{language}.html',
+        'controller' => [FrontendSitemapController::class, 'index'],
+        'methods' => 'GET',
+    ],
     'public.404' => [
         'path' => '/404.html',
         'controller' => [PageNotFoundController::class, 'index'],