Refactor AdminMenu support to match changes

vufind-org · Nov 27, 2024 · f5d2ddc · f5d2ddc
1 parent 344449b
commit f5d2ddc
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 64 deletions.
diff --git a/config/vufind/AdminMenu.yaml b/config/vufind/AdminMenu.yaml
@@ -1,6 +1,10 @@
 # If this file is empty or missing, default settings will be used, matching
-# the examples provided below. The format of this configuration is as follows:
-# array keys for every menu item could be:
+# the examples provided below.
+#
+# Please note that the current implementation of AdminMenu only supports a subset of
+# the options supported by AccountMenu.
+#
+# Array keys for every menu item could be:
 #   - name: name of an item
 #   - label: the text shown as link, will be translated - required
 #   - route: route name used to generate link target - required
@@ -11,32 +15,33 @@
 #     a check whether to show the item. If omitted, item will always display.
 #   - status: whether to show status label, defaults to false
 
-MenuItems:
-  - name: home
-    label: Home
-    route: admin
+Admin:
+  MenuItems:
+    - name: home
+      label: Home
+      route: admin
 
-  - name: socialstats
-    label: Social Statistics
-    route: admin/social
+    - name: socialstats
+      label: Social Statistics
+      route: admin/social
 
-  - name: config
-    label: Configuration
-    route: admin/config
+    - name: config
+      label: Configuration
+      route: admin/config
 
-  - name: maintenance
-    label: System Maintenance
-    route: admin/maintenance
+    - name: maintenance
+      label: System Maintenance
+      route: admin/maintenance
 
-  - name: tags
-    label: Tag Maintenance
-    route: admin/tags
+    - name: tags
+      label: Tag Maintenance
+      route: admin/tags
 
-  - name: feedback
-    label: Feedback Management
-    route: admin/feedback
+    - name: feedback
+      label: Feedback Management
+      route: admin/feedback
 
-  - name: overdrive
-    label: od_admin_menu
-    route: admin/overdrive
-    checkMethod: checkShowOverdrive
+    - name: overdrive
+      label: od_admin_menu
+      route: admin/overdrive
+      checkMethod: checkShowOverdrive
diff --git a/module/VuFind/src/VuFind/Navigation/AbstractMenu.php b/module/VuFind/src/VuFind/Navigation/AbstractMenu.php
@@ -59,8 +59,8 @@ public function getMenu(): array
         $menu = $this->config;
         if (!$menu) {
             $menu = $this->getDefaultMenu();
-        } elseif ($menu['MenuItems'] ?? false) {
-            // backward compatibility for outdated configurations
+        } elseif ($this instanceof AccountMenu && $menu['MenuItems']) {
+            // backward compatibility for outdated AccountMenu configurations
             $default = $this->getDefaultMenu();
             $default['Account']['MenuItems'] = $menu['MenuItems'];
             $menu = $default;

diff --git a/module/VuFind/src/VuFind/Navigation/AdminMenu.php b/module/VuFind/src/VuFind/Navigation/AdminMenu.php
@@ -58,44 +58,48 @@ public function __construct(
      *
      * @return array
      */
-    protected function getDefaultItems(): array
+    protected function getDefaultMenu(): array
     {
         return [
-            [
-                'name' => 'home',
-                'label' => 'Home',
-                'route' => 'admin',
-            ],
-            [
-                'name' => 'socialstats',
-                'label' => 'Social Statistics',
-                'route' => 'admin/social',
-            ],
-            [
-                'name' => 'config',
-                'label' => 'Configuration',
-                'route' => 'admin/config',
-            ],
-            [
-                'name' => 'maintenance',
-                'label' => 'System Maintenance',
-                'route' => 'admin/maintenance',
-            ],
-            [
-                'name' => 'tags',
-                'label' => 'Tag Maintenance ',
-                'route' => 'admin/tags',
-            ],
-            [
-                'name' => 'feedback',
-                'label' => 'Feedback Management',
-                'route' => 'admin/feedback',
-            ],
-            [
-                'name' => 'overdrive',
-                'label' => 'od_admin_menu',
-                'route' => 'admin/overdrive',
-                'checkMethod' => 'checkShowOverdrive',
+            'Admin' => [
+                'MenuItems' => [
+                    [
+                        'name' => 'home',
+                        'label' => 'Home',
+                        'route' => 'admin',
+                    ],
+                    [
+                        'name' => 'socialstats',
+                        'label' => 'Social Statistics',
+                        'route' => 'admin/social',
+                    ],
+                    [
+                        'name' => 'config',
+                        'label' => 'Configuration',
+                        'route' => 'admin/config',
+                    ],
+                    [
+                        'name' => 'maintenance',
+                        'label' => 'System Maintenance',
+                        'route' => 'admin/maintenance',
+                    ],
+                    [
+                        'name' => 'tags',
+                        'label' => 'Tag Maintenance ',
+                        'route' => 'admin/tags',
+                    ],
+                    [
+                        'name' => 'feedback',
+                        'label' => 'Feedback Management',
+                        'route' => 'admin/feedback',
+                    ],
+                    [
+                        'name' => 'overdrive',
+                        'label' => 'od_admin_menu',
+                        'route' => 'admin/overdrive',
+                        'checkMethod' => 'checkShowOverdrive',
+                    ],
+                ],
             ],
         ];
     }

diff --git a/module/VuFind/src/VuFind/View/Helper/Root/AdminMenu.php b/module/VuFind/src/VuFind/View/Helper/Root/AdminMenu.php
@@ -53,7 +53,7 @@ public function render(?string $activeItem = null, string $idPrefix = ''): strin
         return $this->getView()->render(
             'admin/menu.phtml',
             [
-                'items' => $this->getItems(),
+                'items' => $this->getMenu()['Admin']['MenuItems'],
             ]
         );
     }