Initial commit

README.md

@@ -0,0 +1,3 @@
+# mm_requireFields
+
+Visit the following [link](http://code.divandesign.biz/modx/mm_requirefields) to read the documentation, instructions & changelog.

mm_requirefields/index.html

@@ -0,0 +1,2 @@
+<h2>Unauthorized access</h2>
+You're not allowed to access file folder

mm_requirefields/mm_requirefields.php

@@ -0,0 +1,175 @@
+<?php
+/**
+ * mm_requireFields
+ * @version 1.2.3 (2013-07-14)
+ * 
+ * @desc A widget for ManagerManager plugin that allows document fields (or TVs) to become required. The widget appends a red asterisk to a field to indicate it is required, and alerts users if they save the document without completing all required fields.
+ * 
+ * Currently works with text fields only. In the future perhaps this could deal with other elements.
+ * Originally version by Jelle Jager AKA TobyL - Make fields required
+ * Updated by ncrossland to utilise simpler field handline of MM 0.3.5+; bring jQuery code into line; add indication to required fields
+ * 
+ * @uses ManagerManager plugin 0.5.
+ * 
+ * @param $fields {comma separated string} - The name(s) of the document fields (or TVs) that are required. @required
+ * @param $roles {comma separated string} - The roles that the widget is applied to (when this parameter is empty then widget is applied to the all roles).
+ * @param $templates {comma separated string} - Id of the templates to which this widget is applied (when this parameter is empty then widget is applied to the all templates).
+ * 
+ * @link http://code.divandesign.biz/modx/mm_requirefields/1.2.3
+ * 
+ * @copyright 2013
+ */
+
+function mm_requireFields($fields, $roles = '', $templates = ''){
+	global $mm_fields, $mm_current_page, $modx;
+	$e = &$modx->Event;
+
+	// if the current page is being edited by someone in the list of roles, and uses a template in the list of templates
+	if ($e->name == 'OnDocFormRender' && useThisRule($roles, $templates)){
+		// if we've been supplied with a string, convert it into an array
+		$fields = makeArray($fields);
+
+		if (count($fields) == 0) return;
+
+		$output = "\n//  -------------- mm_requireFields :: Begin ------------- \n";
+
+		$output .= '
+		$j("head").append("<style>.mmRequired { background-image: none !important; background-color: #ff9999 !important; } .requiredIcon { color: #ff0000; font-weight: bold; margin-left: 3px; cursor: help; }</style>");
+		var requiredHTML = "<span class=\"requiredIcon\" title=\"Required\">*</span>";
+		';
+
+		$submit_js = '';
+		$load_js = '';
+
+		foreach ($fields as $field){
+			//ignore for now
+			switch ($field){
+				// fields for which this doesn't make sense - in my opinion anyway :)
+				case 'keywords':
+				case 'metatags':
+				case 'hidemenu':
+				case 'which_editor':
+				case 'template':
+				case 'menuindex':
+				case 'show_in_menu':
+				case 'parent':
+				case 'is_folder':
+				case 'is_richtext':
+				case 'log':
+				case 'searchable':
+				case 'cacheable':
+				case 'clear_cache':
+				case 'content_type':
+				case 'content_dispo':
+				case 'which_editor':
+					$output .='';
+				break;
+
+				// Pub/unpub dates don't have a type attribute on their input tag in 1.0.2, so add this. Won't do any harm to other versions
+				case 'pub_date':
+				case 'unpub_date':
+					$load_js .= '
+					$j("#pub_date, #unpub_date").each(function() { this.type = "text";  }); // Cant use jQuery attr function as datepicker class clashes with jQuery methods
+					';
+				// no break, because we want to do the things below too.
+
+				// Ones that follow the regular pattern
+				default:
+					//if it's tv & it's not used in current template
+					if ($mm_fields[$field]['tv'] && tplUseTvs($mm_current_page['template'], $field) === false){
+						//Go to next field
+						continue;
+					}
+
+					// What type is this field?
+					$fieldname = $mm_fields[$field]['fieldname'];
+
+					// What jQuery selector should we use for this fieldtype?
+					switch ($mm_fields[$field]['fieldtype']){
+						case 'textarea':
+							$selector = "textarea[name=$fieldname]";
+						break;
+
+						case 'input': // If it's an input, we only want to do something if it's a text field
+							$selector = "input[type=text][name=$fieldname]";
+						break;
+
+						default:  // all other input types, do nothing
+							$selector = '';
+						break;
+					}
+
+					// If we've found something we want to use
+					if (!empty($selector)){
+						if ($field == 'content'){
+							$label = '$j("#content_header")';
+							$tinymcefix = 'if (typeof(tinyMCE) != "undefined" && typeof(tinyMCE.triggerSave) != "undefined"){tinyMCE.triggerSave();}';
+						}else{
+							$label = '$sel.parents("td:first").prev("td").children("span.warning")';
+							$tinymcefix = '';
+						}
+
+						$submit_js .= '
+
+// The element we are targetting ('.$fieldname.')
+var $sel = $j("'.$selector.'");
+
+'.$tinymcefix.'
+// Check if its valid
+if($j.trim($sel.val()) == ""){// If it is empty
+	// Find the label (this will be easier in Evo 1.1 with more semantic code)
+	var lbl = '.$label.'.text().replace($j(requiredHTML).text(), "");
+		
+	// Add the label to the errors array. Would be nice to say which tab it is on, but no
+	// easy way of doing this in 1.0.x as no semantic link between tabs and tab body
+	errors.push(lbl);
+		
+	// Add an event so the hilight is removed upon focussing
+	$sel.addClass("mmRequired").focus(function(){
+		$j(this).removeClass("mmRequired");
+	});
+}
+						';
+
+						$load_js .= '
+
+// Add an indicator this is required ('.$fieldname.')
+var $sel = $j("'.$selector.'");
+
+// Find the label (this will be easier in Evo 1.1 with more semantic code)
+var $lbl = '.$label.'.append(requiredHTML);
+
+						';
+					}
+				break;
+			}
+		}
+
+		$output .= $load_js.'
+$j("#mutate").submit(function(){
+	var errors = [];
+	
+'.$submit_js.'
+	
+	if(errors.length > 0){
+		var errMsg = errors.length + " required fields are missing:\n\n ";
+		
+		for (var i = 0; i < errors.length; i++){
+			errMsg += " - " + errors[i] + " \n";
+		}
+		errMsg += " \nPlease correct the indicated fields.";
+		
+		alert(errMsg);
+		return false;
+	}else{
+		return true;
+	}
+});
+		';
+
+		$output .= "\n//  -------------- mm_requireFields :: End ------------- \n";
+
+		$e->output($output . "\n");
+	}
+}
+?>