Adding sortability to a page's modules; Removing example module from codebase

Author: jaedb

src/Example.php

@@ -29,7 +29,7 @@ class Module extends DataObject {
 	];
 
 	private static $summary_fields = [
-		'Type' => 'Type',
+		'ClassName' => 'Type',
 		'Title' => 'Title',
 		'Position' => 'Position',
 		'Pages.Count' => 'Number of pages'
@@ -52,7 +52,7 @@ public function getCMSFields() {
 		$fields->addFieldToTab('Root.Main', DropdownField::create(
 				'Position',
 				'Position',
-				Config::inst()->get('ModuleManager', 'positions')
+				Config::inst()->get(ModuleManager::class, 'positions')
 			)->setEmptyString('Please select'));
 		$fields->addFieldToTab("Root.Main", TreeMultiselectField::create("Pages", "Pages", SiteTree::class));
 

src/Module.php

@@ -16,7 +16,6 @@ class Admin extends ModelAdmin {
 		Module::class
     );
 
-
     public function getEditForm($id = null, $fields = null){
         $form = parent::getEditForm($id, $fields);
 

src/ModuleAdmin.php

@@ -16,7 +16,9 @@
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
 use SilverStripe\Forms\GridField\GridFieldAddNewButton;
+use SilverStripe\Forms\GridField\GridFieldPageCount;
 use Symbiote\GridFieldExtensions\GridFieldAddNewMultiClass;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
 
 class ModuleSiteTreeExtension extends DataExtension {
 
@@ -44,34 +46,36 @@ class ModuleSiteTreeExtension extends DataExtension {
 	 * @return FieldList obj
 	 **/
 	public function updateCMSFields(FieldList $fields){
-		
-		// inherit field
-		$fields->addFieldToTab("Root.Modules", $inheritField = CheckboxField::create('InheritModules','Inherit modules')->setDescription('Inherit <strong>all</strong> modules from the parent page. If the parent page is also set to inherit, then we go further up the hierarchy.'));
-		
-		// module manager gridfield
-		$gridFieldConfig = GridFieldConfig_RelationEditor::create();
-		//$gridFieldConfig->addComponent(new GridFieldSortableRows('SortOrder'));
-		
-		$gridField = GridField::create("Modules", "Modules", $this->owner->Modules(), $gridFieldConfig);
-		
-		$gridFieldConfig->removeComponentsByType(GridFieldAddNewButton::class);
-		$gridFieldConfig->addComponent(new GridFieldAddNewMultiClass());
-		$gridField->addExtraClass('modulemanager-modules-field');
+
 		if ($this->owner->InheritModules){
-			$gridField->addExtraClass('hide');
+			$tab_name = "Root.Modules";
+		} else {
+			$tab_name = "Root.Modules (".$this->owner->Modules()->count().")";
+		}
+
+		$fields->removeByName('Modules');
+		
+		$fields->addFieldToTab($tab_name, $inherit_field = CheckboxField::create('InheritModules','Inherit modules')->setDescription('Inherit <strong>all</strong> modules from the parent page. If the parent page is also set to inherit, then we go further up the hierarchy.'));
+
+		// When we inherit, the page's modules become irrelevant
+		if (!$this->owner->InheritModules){
+			$gridfield_config = GridFieldConfig_RelationEditor::create();
+
+			$gridfield = GridField::create("Modules", "Modules", $this->owner->Modules(), $gridfield_config);
+			$gridfield->addExtraClass('modulemanager-modules-field');
+
+			$gridfield_config->addComponent(new GridFieldOrderableRows('SortOrder'));
+			$gridfield_config->addComponent(new GridFieldAddNewMultiClass());
+			$gridfield_config->removeComponentsByType(GridFieldAddNewButton::class);
+			$gridfield_config->removeComponentsByType(GridFieldPageCount::class);
+
+			$fields->addFieldToTab($tab_name, $gridfield);
 		}
 
-		$fields->addFieldToTab("Root.Modules", $gridField);
 
 		return $fields;
 
-	}
-	
-	// get my parent page
-	public function MyParentPage($page){
-		return $page->parent;
-	}
-	
+	}	
 
 	/**
 	 * Get all the modules attached to this page (across all ModuleAreas)
@@ -83,7 +87,12 @@ public function PageModules(){
 
 		// check for inheritance by recursively searching
 		while ($page->InheritModules && $page->ParentID > 0){
-			$page = $this->MyParentPage($page);
+			$page = $page->parent();
+		}
+
+		// We're at the top, but we're still set to inherit, so let's inherit an array of nothing
+		if ($page->InheritModules){
+			return ArrayList::create();
 		}
 
 		return $page->Modules()->sort('SortOrder ASC');
@@ -98,10 +107,10 @@ public function PageModules(){
 	 **/
 	public function ModulePosition($alias, $limit = false){
 
-		$positions = Config::inst()->get('ModuleManager', 'positions');
+		$positions = Config::inst()->get(ModuleManager::class, 'positions');
 
 		if (!$positions || !isset($positions[$alias])){
-			user_error("Trying to call module position \"".$alias."\" but this doesn't exist. Make sure you have setup your custom positions in your config.yml",E_USER_NOTICE);
+			user_error("Module position \"".$alias."\" doesn't exist. Have setup your custom positions in your config.yml?",E_USER_NOTICE);
 		}
 
 		// get this page's module list for specified position