feat(api): added configuration for only active categories in API (#3876)

Author: thorsten

phpmyfaq/src/phpMyFAQ/Category.php

@@ -306,6 +306,7 @@ public function getCategoriesPaginated(
         int $offset = 0,
         string $sortField = 'id',
         string $sortOrder = 'ASC',
+        bool $activeOnly = false,
     ): array {
         $categories = [];
         $rows = $this->getCategoryRepository()->findCategoriesPaginated(
@@ -314,6 +315,7 @@ public function getCategoriesPaginated(
             $offset,
             $sortField,
             $sortOrder,
+            $activeOnly,
         );
         foreach ($rows as $id => $row) {
             $categories[$id] = $row
@@ -328,11 +330,12 @@ public function getCategoriesPaginated(
     /**
      * Counts total categories for current language.
      *
+     * @param bool $activeOnly Only count active categories
      * @return int Total count
      */
-    public function countCategories(): int
+    public function countCategories(bool $activeOnly = false): int
     {
-        return $this->getCategoryRepository()->countCategories($this->language);
+        return $this->getCategoryRepository()->countCategories($this->language, $activeOnly);
     }
 
     /**

phpmyfaq/src/phpMyFAQ/Category/CategoryRepository.php

@@ -183,23 +183,33 @@ public function findCategoriesPaginated(
         int $offset = 0,
         string $sortField = 'id',
         string $sortOrder = 'ASC',
+        bool $activeOnly = false,
     ): array {
         $categories = [];
-        $prefix = Database::getTablePrefix();
 
-        // Whitelist validation for sort field
+        // Whitelist validation for the sort field
         $allowedSortFields = ['id', 'name', 'parent_id', 'active'];
         if (!in_array($sortField, $allowedSortFields, strict: true)) {
             $sortField = 'id';
         }
 
         $query = sprintf(
             'SELECT id, lang, parent_id, name, description, user_id, group_id, active, show_home, image FROM %sfaqcategories',
-            $prefix,
+            Database::getTablePrefix(),
         );
 
+        $whereConditions = [];
+
         if ($language !== null && preg_match(pattern: '/^[a-z\-]{2,}$/', subject: $language)) {
-            $query .= " WHERE lang = '" . $this->configuration->getDb()->escape($language) . "'";
+            $whereConditions[] = "lang = '" . $this->configuration->getDb()->escape($language) . "'";
+        }
+
+        if ($activeOnly) {
+            $whereConditions[] = 'active = 1';
+        }
+
+        if (!empty($whereConditions)) {
+            $query .= ' WHERE ' . implode(' AND ', $whereConditions);
         }
 
         $query .= sprintf(' ORDER BY %s %s LIMIT %d OFFSET %d', $sortField, $sortOrder, $limit, $offset);
@@ -220,14 +230,25 @@ public function findCategoriesPaginated(
      * Count total categories for a language.
      *
      * @param string|null $language Language code filter
+     * @param bool $activeOnly Only count active categories
      * @return int Total count
      */
-    public function countCategories(?string $language = null): int
+    public function countCategories(?string $language = null, bool $activeOnly = false): int
     {
         $query = sprintf('SELECT COUNT(*) as total FROM %sfaqcategories', Database::getTablePrefix());
 
+        $whereConditions = [];
+
         if ($language !== null && preg_match(pattern: '/^[a-z\-]{2,}$/', subject: $language)) {
-            $query .= " WHERE lang = '" . $this->configuration->getDb()->escape($language) . "'";
+            $whereConditions[] = "lang = '" . $this->configuration->getDb()->escape($language) . "'";
+        }
+
+        if ($activeOnly) {
+            $whereConditions[] = 'active = 1';
+        }
+
+        if (!empty($whereConditions)) {
+            $query .= ' WHERE ' . implode(' AND ', $whereConditions);
         }
 
         $result = $this->configuration->getDb()->query($query);

phpmyfaq/src/phpMyFAQ/Controller/Api/CategoryController.php

@@ -137,6 +137,8 @@ public function list(): JsonResponse
         $category->setGroups($currentGroups);
         $category->setLanguage($currentLanguage);
 
+        $onlyActive = (bool) $this->configuration->get('api.onlyActiveCategories');
+
         // Get pagination and sorting parameters
         $pagination = $this->getPaginationRequest();
         $sort = $this->getSortRequest(
@@ -151,10 +153,11 @@ public function list(): JsonResponse
             offset: $pagination->offset,
             sortField: $sort->getField() ?? 'id',
             sortOrder: $sort->getOrderSql(),
+            activeOnly: $onlyActive,
         );
 
         // Get total count
-        $total = $category->countCategories();
+        $total = $category->countCategories(activeOnly: $onlyActive);
 
         return $this->paginatedResponse(
             data: array_values($categories),