Ensure Analytics category is always shown at top, #PG-4052

Author: AltamashShaikh

API/TemplateMetadata.php

@@ -23,6 +23,7 @@ class TemplateMetadata
     public function formatTemplates($templates)
     {
         $byCategory = [];
+        $analyticsCategory = [];
         foreach ($templates as $template) {
             if (is_array($template)) {
                 $tagArray = $template;
@@ -31,7 +32,16 @@ public function formatTemplates($templates)
             }
 
             $category = $tagArray['category'];
-            if (!isset($byCategory[$category])) {
+            if ($category === Piwik::translate('TagManager_CategoryAnalytics')) {
+                if (!isset($analyticsCategory['types'])) {
+                    $analyticsCategory = [
+                        'name' => $category,
+                        'types' => []
+                    ];
+                }
+                $analyticsCategory['types'][] = $tagArray;
+                continue;
+            } elseif (!isset($byCategory[$category])) {
                 $byCategory[$category] = [
                     'name' => $category,
                     'types' => []
@@ -62,6 +72,6 @@ public function formatTemplates($templates)
             });
         }
 
-        return $byCategory;
+        return $analyticsCategory ? array_merge([$analyticsCategory], $byCategory) : $byCategory;
     }
 }

Template/Variable/BaseVariable.php

@@ -31,6 +31,7 @@ abstract class BaseVariable extends BaseTemplate
     public const CATEGORY_DEVICE = 'TagManager_CategoryDevice';
     public const CATEGORY_SEO = 'TagManager_CategorySEO';
     public const CATEGORY_OTHERS = 'General_Others';
+    public const CATEGORY_ANALYTICS = 'TagManager_CategoryAnalytics';
 
     protected $templateType = 'Variable';
 

Template/Variable/MatomoConfigurationVariable.php

@@ -32,7 +32,7 @@ public function getId()
 
     public function getCategory()
     {
-        return self::CATEGORY_OTHERS;
+        return self::CATEGORY_ANALYTICS;
     }
 
     public function getIcon()

tests/Unit/API/TemplateMetadataTest.php

@@ -42,8 +42,32 @@ public function test_formatTemplates_BasedOnArrays()
             ['category' => 'Baz', 'name' => 'ZooName', 'order' => 10],
             ['category' => 'Baz', 'name' => 'FooName', 'order' => 10],
             ['category' => 'Baz', 'name' => 'AooName', 'order' => 10],
+            ['category' => 'A', 'name' => 'First Name', 'order' => 10], // should come after Analytics category
+            ['category' => 'Analytics', 'name' => 'Matomo Configuration', 'order' => 1000], // should be the first category
         );
         $expected = array (
+            array (
+                'name' => 'Analytics',
+                'types' =>
+                    array (
+                        array (
+                            'category' => 'Analytics',
+                            'name' => 'Matomo Configuration',
+                            'order' => 1000,
+                        ),
+                    ),
+            ),
+            array (
+                'name' => 'A',
+                'types' =>
+                    array (
+                        array (
+                            'category' => 'A',
+                            'name' => 'First Name',
+                            'order' => 10,
+                        ),
+                    ),
+            ),
             array (
                 'name' => 'Bar',
                 'types' =>