Merge pull request daffl#20 from Perlover/feature/validate-opts

David Luecke · David Luecke · commit 7c6db533785a · 2011-08-24T14:38:50.000-07:00
Documentation of 'validate' subscriber was corrected and has been added the example of validate subscriber
diff --git a/src/dform.extensions.js b/src/dform.extensions.js
@@ -550,10 +550,49 @@
 		 * subscriber: validate
 		 * 
 		 * Adds support for the jQuery validation rulesets.
+		 * For types: <text>, <password>, <textarea>, <radio>, <checkbox> sets up rules through rules("add", rules) for validation plugin
+		 * For type <form> sets up as options object for validate method of validation plugin
+		 * For rules of types <checkboxes> and <radiobuttons> you should use this subscriber for type <form> (to see example below)
 		 * 
-		 * Parameters:
-		 * options - Options as specified in the rules parameter
-		 * type - The type of the *this* element
+		 * Example:
+		 * validations for radiobuttons group and for text field:
+		 * 
+		 * (start code)
+		 * {
+		 *	"type" : "form",
+		 * 	"validate" :
+		 *	{
+		 *		"rules" :
+		 *		{
+		 *			"radio_group": "required"
+		 *		}
+		 *	},
+		 *	"elements" :
+		 *	[
+		 *		{
+		 *			"type" : "radiobuttons",
+		 *			"caption" : "You should choose from here"
+		 *			"name" : "radio_group",
+		 *			"options" :
+		 *			{
+		 *				"Y" : "Yes",
+		 *				"N" : "No"
+		 *			}
+		 *
+		 *		},
+		 *		{
+		 *			"type" : "text",
+		 *			"name" : "url",
+		 *			"validate" :
+		 *			{
+		 *				"required" : true,
+		 *				"url" : true
+		 *			}
+		 *		}
+		 *	
+		 *	]
+		 * }
+		 * (end)
 		 */
 		"validate" : function(options, type)
 		{
