Merge pull request #6 from jaedb/2.0

2.0

Author: jaedb

README.md

@@ -20,7 +20,13 @@ Manage site-wide modules (aka widgets) and select the pages on which they are to
 # Usage
 
 ### Create a module area
-1. Within the *Module Manager* admin, create a new ModulePosition object. The `Alias` field will be automatically generated, or you can enter your custom alias name.
+1. Edit your `mysite/_config/config.yml` file to add any additional module areas. Use the following format:
+  ```
+  ModuleManager:
+    positions:
+      - 'module-name-here'
+  ```
+
 2. In your template, use the code `$ModulePosition(alias)` where alias is your position's alias string.
 3. Flush your template cache (`?flush=all`)
 

_config.php

@@ -0,0 +1,3 @@
+ModuleManager:
+  positions:
+    - 'sidebar'

_config/config.yml

@@ -1,7 +1,11 @@
 <?php
 
 class ModuleManager extends DataObject {
-
+	
+	private static $db = array(
+		'Positions' => 'Text'
+	);
+	
 	public function getCMSFields() {
 		$fields = FieldList::create( $tabSet = TabSet::create('Root'));		
 		return $fields;
@@ -11,28 +15,83 @@ public function setRequest($req){
 		return false;
 	}
 
+	public function CMSEditLink() {
+		return singleton('ModuleManagerController')->Link();
+	}
+
+	public function populateDefaults() {
+		$this->Positions = 'asdfasdfasfd';//serialize( array('header','footer','sidebar') );
+		
+		// Allow these defaults to be overridden
+		parent::populateDefaults();
+	}
+	
 	public function requireDefaultRecords() {
 		parent::requireDefaultRecords();
-		$moduleManager = ModuleManager::get()->First();
+		$moduleManager = DataObject::get_one('ModuleManager');
 		if(!$moduleManager) {
 			self::make_module_manager();
 			DB::alteration_message("Added default module manager","created");
 		}
 	}
 
-	static public function make_module_manager() {
+	public static function make_module_manager() {
 		$moduleManager = ModuleManager::create();
 		$moduleManager->write();
 		return $moduleManager;
 	}
 
-	public static function CurrentModuleManager(){		
-		$current = ModuleManager::get()->First();		
-		return $current;
+	/**
+	 * Get the current site's ModuleManager, and creates a new one through 
+	 * {@link make_module_manager()} if none is found.
+	 *
+	 * @return ModuleManager
+	 */
+	public static function current_module_manager() {
+		if( $moduleManager = DataObject::get_one('ModuleManager') ){
+			return $moduleManager;
+		}
+		
+		return self::make_module_manager();
 	}
 
-	public function CMSEditLink() {
-		return singleton('ModuleManagerController')->Link();
+	
+	/**
+	 * Get the positions
+	 * @return array
+	 **/
+	public static function get_positions(){
+		return ModuleManager::config()->positions;
+	}
+	
+	
+	/**
+	 * Build positions array into dropdown key => value format for CMS fields
+	 * @return array
+	 **/
+	public static function get_positions_dropdown(){
+		$array = [];
+		foreach( ModuleManager::config()->positions as $position ){
+			$array[$position] = $position;
+		}
+		return $array;
+	}
+	
+	
+	/**
+	 * Get the positions in string format (for building Enum values)
+	 * @return array
+	 **/
+	public static function getPositionsAsString(){
+		$positions = self::getPositions();
+		$string = '';
+		foreach( $positions as $position ){
+			if( $string != '' ){
+				$string .= ',';
+			}
+			$string .= '"'.$position.'"';
+		}
+		return $string;
 	}
 
 }

code/Admin/ModuleManager.php

@@ -26,7 +26,7 @@ public function getResponseNegotiator() {
 	public function getEditForm($id = null, $fields = null) {
 
 		// get the cmsfields from ModuleManager DataObject
-		$moduleManager = ModuleManager::CurrentModuleManager();
+		$moduleManager = ModuleManager::current_module_manager();
 		$fields = $moduleManager->getCMSFields();
 
 		// what pages is this module active on
@@ -36,21 +36,22 @@ public function getEditForm($id = null, $fields = null) {
 				Module::get(), 
 				$modulesGridFieldConfig = GridFieldConfig_RecordEditor::create()
 			);
-		$modulePositionsGridField = GridField::create(
-				"ModulePositions_Gridfield", 
-				"Module Positions", 
-				ModulePosition::get(), 
-				GridFieldConfig_RecordEditor::create()
-			);
 
 		// add multiclass dropdown for modules
 		$modulesGridFieldConfig->removeComponentsByType('GridFieldAddNewButton');
 		$modulesGridFieldConfig->addComponent(new GridFieldAddNewMultiClass());
 
 		// add the fields
 		$fields->addFieldToTab('Root.Modules', $modulesGridField);
-		$fields->addFieldToTab('Root.ModulePositions', $modulePositionsGridField);
-		$fields->addFieldToTab('Root.ModulePositions', LiteralField::create('html','<em>To load a position into your template, simply write <code>$ModulePosition(Alias)</code> where <code>Alias</code> is your position alias</em>'));
+		
+		// module positions tab
+		$positionsHtml = '<h2>Module positions</h2>';
+		$positionsHtml .= '<p class="message info">To change these you need to edit the positions specified in the <code>_config.php</code> file. These are your currently configured positions available:</p>';
+		foreach( ModuleManager::config()->positions as $position ){
+			$positionsHtml .= '<p>&bull;&nbsp; <strong>'.$position.'</strong><br />&nbsp; &nbsp; Use in your template with <code>$ModulePosition("'.$position.'");</code></p>';
+		}		
+		$positionsHtml .= '</ul>';
+		$fields->addFieldToTab('Root.Positions', LiteralField::create('html',$positionsHtml));
 
 		// actions
 		$actions = $moduleManager->getCMSActions();

code/Admin/ModuleManagerController.php

@@ -11,13 +11,9 @@ class Module extends DataObject {
 
 	// set object parameters
 	private static $db = array(
-		'Title' => 'Varchar(128)',
+		'Title' => 'Varchar(255)',
 		'Content' => 'HTMLText',
-		'Alias' => 'Text'
-	);
-	
-	private static $has_one = array(
-		'Position' => 'ModulePosition'
+		'Position' => 'Varchar(255)'
 	);
 
 	private static $belongs_many_many = array(
@@ -27,7 +23,7 @@ class Module extends DataObject {
 	private static $summary_fields = array(
 		'Type' => 'Type',
 		'Title' => 'Title',
-		'PositionNameNice' => 'Position',
+		'Position' => 'Position',
 		'Pages.Count' => 'Number of pages'
 	);
 
@@ -36,16 +32,6 @@ class Module extends DataObject {
 		'PositionID'
 	);
 
-	/**
-	 * The position name that this module is assigned to
-	 * @return string
-	 **/
-	public function PositionNameNice(){
-		if( $this->Position()->ID > 0 )
-			return $this->Position()->Title .' ('.$this->Position()->Alias.')';
-		return false;
-	}
-	
 	/**
 	 * Identify this page component type
 	 * Used in GridField for type identification
@@ -81,52 +67,17 @@ public function getCMSFields() {
 		$fields->addFieldToTab('Root.Main', LiteralField::create('html','<p><em>'.$this->getDescription().'</em></p><br />') );
 
 		$fields->addFieldToTab('Root.Main', TextField::create('Title', 'Title'));
-		$fields->addFieldToTab('Root.Main', TextField::create('Alias', 'Alias (unique identifier)'));
 		$fields->addFieldToTab('Root.Main', DropdownField::create(
-				'PositionID',
 				'Position',
-				$this->GetModulePositions()
-			));
+				'Position',
+				ModuleManager::get_positions_dropdown()
+			)->setEmptyString('Please select'));
+		$fields->addFieldToTab("Root.Main", TreeMultiselectField::create("Pages", "Shown on pages", "SiteTree"));
         $fields->addFieldToTab('Root.Main', HTMLEditorField::create('Content', 'Content') );
 
-		$pagesField = TreeMultiselectField::create("Pages", "Shown on pages", "SiteTree");
-		$fields->addFieldToTab("Root.Main", $pagesField, 'Content');
-		
 		return $fields;
 	}
 
-	/**
-	 * List all ModulePosition objects
-	 * @return array
-	 **/
-	function GetModulePositions(){
-	
-		if($Positions = DataObject::get('ModulePosition')){
-			
-			// construct container
-			$map = array();
-			
-			// loop each position and inject into map
-			foreach( $Positions as $Position ){
-				$map[$Position->ID] = $Position->Title .' ('.$Position->Alias.')';
-			}
-			
-			return $map;
-		}else{
-			return array('You need to create a Module Position first');
-		}
-	}
-	
-	/**
-	 * Get this ModulePosition's name
-	 * @return string
-	 **/
-	function ModulePositionName(){
-		
-		$position = ModulePosition::get()->byID($this->ModulePosition);
-		return $position->Title;
-	}
-	
 	/**
 	 * Render the module-wrapper template
 	 * @return HTMLText
@@ -142,57 +93,5 @@ public function ModuleLayout(){
 			// TODO: Make this work. To make it work we actually need to properly check if we have a custom template for this class.
 
 		return $output;
-	}
-	
-	
-	/**
-	 * Convert string into url-friendly string
-	 * @param $string = string (ie the title)
-	 * @return string
-	 **/
-	public function URLFriendly( $string ){
-	
-		// replace non letter or digits by -
-		$string = preg_replace('~[^\\pL\d]+~u', '-', $string);
-		$string = trim($string, '-');
-
-		// transliterate
-		$string = iconv('utf-8', 'us-ascii//TRANSLIT', $string);
-
-		// lowercase
-		$string = strtolower($string);
-
-		// remove unwanted characters
-		$string = preg_replace('~[^-\w]+~', '', $string);
-
-		if (empty($string))
-			return 'n-a';
-
-		return $string;
-	}
-	
-	// before saving, check alias
-	public function onBeforeWrite(){
-	
-		parent::onBeforeWrite();
-		
-		// convert name to lowercase, dashed
-		$newAlias = $this->URLFriendly($this->Title);
-		
-		// get positions that already have this alias
-		$moduleAliasesThatMatch = ModulePosition::get()->Filter('Alias',$newAlias)->First();
-		
-		// if we find a match
-		if( isset($moduleAliasesThatMatch->ID) ){
-			
-			// create a new unique alias (based on ID)
-			$this->Alias = $newAlias .'-'. $this->ID;
-		
-		// no match, meaning we're safe to use this as a unique alias
-		}else{			
-			$this->Alias = $newAlias;
-		}
-		
-	}
-	
+	}	
 }