Merge pull request #1 from dnadesign/feature/subsite-config

Update menuset to allow subsite menu configurations

Author: djmattski

README.md

@@ -10,20 +10,8 @@ This module was inspired by the following modules, but modified for our tastes:
 This module is baked for Silverstripe 4 and Php 8
 
 ## Installation
+`composer require dnadesign/silverstripe-setmenu`
 
-This module is not yet published on packagist, so install the module by including it in your **composer.json** with a repository definition.
-
-```
-    "require": {
-        "dnadesign/silverstripe-setmenu": "dev-master"
-    },
-    "repositories": [
-        {
-            "type": "vcs",
-            "url": "https://github.com/dnadesign/silverstripe-setmenu.git"
-        }
-    ],
-```
 ## Configuration
 Define the **MenuSet**s and the group they belong to in .yml configuration by setting `default_sets`. 
 
@@ -36,7 +24,18 @@ DNADesign\SetMenu\Model\MenuSet:
     Main nav: Main
     Main footer: Footer
     Secondary footer: Footer
-    Auxilliary Footer: Footer
+```
+Additionally, subsite menusets can be configured. Currently the mechanism to do this is to match the theme name to the menu definition. This would also require a template to be copied to the subsite theme to override it and make use of the different menu sets.
+i.e.
+
+```
+DNADesign\SetMenu\Model\MenuSet:
+  default_sets:
+    Main nav: Main
+    Main footer: Footer
+  subsitetheme:
+    Primary: Main
+    Auxilliary: Secondary
 ```
 
 On `/dev/build` they will be created automatically.

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "dnadesign/silverstripe-setmenu",
     "type": "silverstripe-vendormodule",
-    "description" : "A SilverStripe module for managing configurable and sortable menu sets.",
+    "description" : "A SilverStripe module for managing configurable and orderable menu sets.",
     "license": "BSD-3-Clause",
     "require": {
         "php": "^8",

src/Admin/MenuAdmin.php

@@ -10,6 +10,7 @@
 use SilverStripe\Forms\GridField\GridFieldAddNewButton;
 use SilverStripe\Forms\GridField\GridFieldExportButton;
 use SilverStripe\Forms\GridField\GridFieldImportButton;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
 
 class MenuAdmin extends ModelAdmin
 {
@@ -38,6 +39,17 @@ public function getGridFieldConfig(): GridFieldConfig
         return $config;
     }
 
+    public function getEditForm($id = null, $fields = null)
+    {
+        $form = parent::getEditForm($id, $fields);
+
+        $gridFieldName = $this->sanitiseClassName($this->modelClass);
+        $gridField = $form->Fields()->fieldByName($gridFieldName);
+        $gridField->getConfig()->addComponent(new GridFieldOrderableRows());
+
+        return $form;
+    }
+
     /**
      * Filter by Subsite ID if the module is present
      *

src/Model/MenuSet.php

@@ -19,7 +19,8 @@ class MenuSet extends DataObject implements PermissionProvider
     private static $db = [
         'Key' => 'Varchar(255)',
         'Name' => 'Varchar(255)',
-        'Type' => 'Varchar(255)'
+        'Type' => 'Varchar(255)',
+        'Sort' => 'Int',
     ];
 
     private static $has_many = [
@@ -35,25 +36,37 @@ class MenuSet extends DataObject implements PermissionProvider
         'Type'
     ];
 
+    private static $default_sort = 'Sort';
+
     /**
      * Create the MenuSets as defined in configuration
      */
     public function requireDefaultRecords()
     {
         parent::requireDefaultRecords();
 
-        $defaultSets = $this->getMenuSetsFromConfig();
+        $defaultSets = $this->getMenuSetsFromConfig('default_sets');
+
+        // Create menu sets for the main site (SubsiteID = 0)
+        $this->createMenuSetsFromConfig($defaultSets);
 
+        // Check for subsites
         if (class_exists('SilverStripe\Subsites\Model\Subsite')) {
-            $subsites = Subsite::all_sites();
+            $subsites = Subsite::all_sites(false);
 
-            $subsites->each(function ($subsite) use ($defaultSets) {
+            $subsites->each(function ($subsite) {
                 Subsite::changeSubsite($subsite->ID);
 
-                $this->createMenuSetsFromConfig($defaultSets, $subsite->ID);
+                // Retrieve menu sets based on subsite's theme name
+                if (!$subsite->Theme) {
+                    return;
+                }
+
+                $subsiteSets = $this->getMenuSetsFromConfig($subsite->Theme);
+                if ($subsiteSets) {
+                    $this->createMenuSetsFromConfig($subsiteSets, $subsite->ID);
+                }
             });
-        } else {
-            $this->createMenuSetsFromConfig($defaultSets);
         }
     }
 
@@ -101,9 +114,9 @@ public function createMenuSetsFromConfig($defaultSets, $subsiteID = null)
      *
      * @return String[]
      */
-    public function getMenuSetsFromConfig()
+    public function getMenuSetsFromConfig($setType)
     {
-        return $this->config()->get('default_sets') ?: [];
+        return $this->config()->get($setType) ?: [];
     }
 
     public function getCMSFields()
@@ -112,7 +125,8 @@ public function getCMSFields()
 
         $fields->removeByName([
             'Key',
-            'MenuItems'
+            'MenuItems',
+            'Sort'
         ]);
 
         $fields->addFieldsToTab(
@@ -187,6 +201,6 @@ public function canDelete($member = null)
      */
     public function isDefaultSet()
     {
-        return array_key_exists($this->Key, $this->getMenuSetsFromConfig());
+        return array_key_exists($this->Key, $this->getMenuSetsFromConfig('default_sets'));
     }
 }