Dev #14878: Fixed order for 'Question attribute Category' (#2183)

Co-authored-by: encuestabizdevgit <devgit@encuesta.biz>
LimeSurvey · Dec 29, 2021 · f4d4c1b · f4d4c1b
1 parent 91f3685
commit f4d4c1b
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 12 deletions.
diff --git a/application/helpers/common_helper.php b/application/helpers/common_helper.php
@@ -2051,16 +2051,6 @@ function getQuestionAttributeValue($questionAttributeArray, $attributeName, $lan
     }
 }
 
-
-function categorySort($a, $b)
-{
-    $result = strnatcasecmp($a['category'], $b['category']);
-    if ($result == 0) {
-        $result = $a['sortorder'] - $b['sortorder'];
-    }
-    return $result;
-}
-
 function questionTitleSort($a, $b)
 {
     $result = strnatcasecmp($a['title'], $b['title']);

diff --git a/application/models/services/QuestionAttributeFetcher.php b/application/models/services/QuestionAttributeFetcher.php
@@ -56,9 +56,9 @@ public function fetch()
         }
 
         // Sort by category
-        uasort($allAttributes, 'categorySort');
+        $sortedAttributes = $questionAttributeHelper->sortAttributesByCategory($allAttributes);
 
-        return $allAttributes;
+        return $sortedAttributes;
     }
 
     /**
@@ -159,4 +159,5 @@ public function setAdvancedOnly($advancedOnly)
     {
         $this->setOption('advancedOnly', $advancedOnly);
     }
+
 }
diff --git a/application/models/services/QuestionAttributeHelper.php b/application/models/services/QuestionAttributeHelper.php
@@ -218,4 +218,62 @@ public function getQuestionAttributesWithValues($question, $language = null, $qu
 
         return $questionAttributesWithValues;
     }
+
+    /**
+     * Comparison function for sorting question attributes by category with uasort().
+     *
+     * @param array<string,mixed> $a    First question attribute to compare
+     * @param array<string,mixed> $b    Second question attribute to compare
+     * @return int
+     */
+    private function categorySort($a, $b)
+    {
+        $categoryOrders = $this->getCategoryOrders();
+        $orderA = isset($categoryOrders[$a['category']]) ? $categoryOrders[$a['category']] : PHP_INT_MAX;
+        $orderB = isset($categoryOrders[$b['category']]) ? $categoryOrders[$b['category']] : PHP_INT_MAX;
+        if ($orderA == $orderB) {
+            $result = strnatcasecmp($a['category'], $b['category']);
+            if ($result == 0) {
+                $result = $a['sortorder'] - $b['sortorder'];
+            }
+        } else {
+            $result = $orderA - $orderB;
+        }
+        return $result;
+    }
+
+    /**
+     * Returns the array of categories with their assigned order.
+     * The array doesn't contain all the posible categories, only those with an order assigned.
+     *
+     * @return array<string,int>
+     */
+    public function getCategoryOrders()
+    {
+        $orders = [
+            'Logic' => 1,
+            'Display' => 2,
+            'Input' => 3,
+            'Other' => 4,
+            'Timer' => 5,
+            'Statistics' => 6,
+        ];
+        return $orders;
+    }
+
+    /**
+     * Sorts an array of question attributes by category.
+     * Sorting is based on a predefined list of orders (see QuestionAtributeHelper::getCategoryOrders()).
+     * Categories without a predefined order are considered less relevant.
+     * Categories with the same order are sorted alphabetically.
+     *
+     * @param array<string,array> $attributes
+     * @return array<string,array>
+     */
+    public function sortAttributesByCategory($attributes)
+    {
+        $attributesCopy = $attributes;
+        uasort($attributesCopy, [$this, 'categorySort']);
+        return $attributesCopy;
+    }
 }