Merge pull request #9 from stecman/default-menu-sets

Allow configuring default menu sets in yaml config

README.md

@@ -40,8 +40,16 @@ There are 2 main steps to creating a menu using menu management.
 
 ### Creating a MenuSet
 
-This is pretty straight forward. You just give the MenuSet a Name (which is what
-you reference in the templates when controlling the menu)
+This is pretty straight forward. You just give the MenuSet a Name (which is what you reference in the templates when controlling the menu).
+
+As it is common to reference MenuSets by name in templates, you can configure sets to be created automatically during the /dev/build task. These sets cannot be deleted through the CMS.
+
+```yaml
+MenuSet:
+  default_sets:
+    - Main
+    - Footer
+```
 
 
 ### Creating MenuItems

code/MenuSet.php

@@ -52,7 +52,7 @@ public function canCreate($member = null)
      */
     public function canDelete($member = null)
     {
-        return Permission::check('MANAGE_MENU_SETS');
+        return !$this->isDefaultSet() && Permission::check('MANAGE_MENU_SETS');
     }
     /**
      * @param null $member
@@ -77,6 +77,36 @@ public function Children()
     {
         return $this->MenuItems();
     }
+
+    /**
+     * Check if this menu set appears in the default sets config
+     * @return bool
+     */
+    public function isDefaultSet()
+    {
+        return in_array($this->Name, $this->getDefaultSetNames());
+    }
+
+    /**
+     * Set up default records based on the yaml config
+     */
+    public function requireDefaultRecords()
+    {
+        parent::requireDefaultRecords();
+
+        foreach ($this->getDefaultSetNames() as $name) {
+            $existingRecord = MenuSet::get()->filter('Name', $name)->first();
+
+            if (!$existingRecord) {
+                $set = new MenuSet();
+                $set->Name = $name;
+                $set->write();
+
+                DB::alteration_message("MenuSet '$name' created", 'created');
+            }
+        }
+    }
+
     /**
      * @return FieldList
      */
@@ -106,9 +136,7 @@ public function getCMSFields()
 
         return $fields;
     }
-    /**
-     *
-     */
+
     public function onBeforeDelete()
     {
         $menuItems = $this->MenuItems();
@@ -122,4 +150,13 @@ public function onBeforeDelete()
         parent::onBeforeDelete();
     }
 
+    /**
+     * Get the MenuSet names configured under MenuSet.default_sets
+     * 
+     * @return string[]
+     */
+    protected function getDefaultSetNames()
+    {
+        return $this->config()->get('default_sets') ?: array();
+    }
 }