Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / validations.html
index 4237f81..e8f13db 100644 (file)
@@ -1,54 +1,79 @@
-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.validations'>/**
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>The source code</title>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <style type="text/css">
+    .highlight { display: block; background-color: #ddd; }
+  </style>
+  <script type="text/javascript">
+    function highlight() {
+      document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+    }
+  </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+  <pre class="prettyprint lang-js"><span id='Ext-data-validations'>/**
 </span> * @author Ed Spencer
- * @class Ext.data.validations
- * @extends Object
- * 
- * &lt;p&gt;This singleton contains a set of validation functions that can be used to validate any type
- * of data. They are most often used in {@link Ext.data.Model Models}, where they are automatically
- * set up and executed.&lt;/p&gt;
+ *
+ * This singleton contains a set of validation functions that can be used to validate any type of data. They are most
+ * often used in {@link Ext.data.Model Models}, where they are automatically set up and executed.
  */
 Ext.define('Ext.data.validations', {
     singleton: true,
     
-<span id='Ext-data.validations-property-presenceMessage'>    /**
-</span>     * The default error message used when a presence validation fails
-     * @property presenceMessage
-     * @type String
+<span id='Ext-data-validations-property-presenceMessage'>    /**
+</span>     * @property {String} presenceMessage
+     * The default error message used when a presence validation fails.
      */
     presenceMessage: 'must be present',
     
-<span id='Ext-data.validations-property-lengthMessage'>    /**
-</span>     * The default error message used when a length validation fails
-     * @property lengthMessage
-     * @type String
+<span id='Ext-data-validations-property-lengthMessage'>    /**
+</span>     * @property {String} lengthMessage
+     * The default error message used when a length validation fails.
      */
     lengthMessage: 'is the wrong length',
     
-<span id='Ext-data.validations-property-formatMessage'>    /**
-</span>     * The default error message used when a format validation fails
-     * @property formatMessage
-     * @type Boolean
+<span id='Ext-data-validations-property-formatMessage'>    /**
+</span>     * @property {Boolean} formatMessage
+     * The default error message used when a format validation fails.
      */
     formatMessage: 'is the wrong format',
     
-<span id='Ext-data.validations-property-inclusionMessage'>    /**
-</span>     * The default error message used when an inclusion validation fails
-     * @property inclusionMessage
-     * @type String
+<span id='Ext-data-validations-property-inclusionMessage'>    /**
+</span>     * @property {String} inclusionMessage
+     * The default error message used when an inclusion validation fails.
      */
     inclusionMessage: 'is not included in the list of acceptable values',
     
-<span id='Ext-data.validations-property-exclusionMessage'>    /**
-</span>     * The default error message used when an exclusion validation fails
-     * @property exclusionMessage
-     * @type String
+<span id='Ext-data-validations-property-exclusionMessage'>    /**
+</span>     * @property {String} exclusionMessage
+     * The default error message used when an exclusion validation fails.
      */
     exclusionMessage: 'is not an acceptable value',
     
-<span id='Ext-data.validations-method-presence'>    /**
-</span>     * Validates that the given value is present
-     * @param {Object} config Optional config object
-     * @param {Mixed} value The value to validate
+<span id='Ext-data-validations-property-emailMessage'>    /**
+</span>     * @property {String} emailMessage
+     * The default error message used when an email validation fails
+     */
+    emailMessage: 'is not a valid email address',
+    
+<span id='Ext-data-validations-property-emailRe'>    /**
+</span>     * @property {RegExp} emailRe
+     * The regular expression used to validate email addresses
+     */
+    emailRe: /^([a-zA-Z0-9_\.\-])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/,
+    
+<span id='Ext-data-validations-method-presence'>    /**
+</span>     * Validates that the given value is present.
+     * For example:
+     *
+     *     validations: [{type: 'presence', field: 'age'}]
+     *
+     * @param {Object} config Config object
+     * @param {Object} value The value to validate
      * @return {Boolean} True if validation passed
      */
     presence: function(config, value) {
@@ -56,17 +81,22 @@ Ext.define('Ext.data.validations', {
             value = config;
         }
         
-        return !!value;
+        //we need an additional check for zero here because zero is an acceptable form of present data
+        return !!value || value === 0;
     },
     
-<span id='Ext-data.validations-method-length'>    /**
-</span>     * Returns true if the given value is between the configured min and max values
-     * @param {Object} config Optional config object
+<span id='Ext-data-validations-method-length'>    /**
+</span>     * Returns true if the given value is between the configured min and max values.
+     * For example:
+     *
+     *     validations: [{type: 'length', field: 'name', min: 2}]
+     *
+     * @param {Object} config Config object
      * @param {String} value The value to validate
      * @return {Boolean} True if the value passes validation
      */
     length: function(config, value) {
-        if (value === undefined) {
+        if (value === undefined || value === null) {
             return false;
         }
         
@@ -81,9 +111,23 @@ Ext.define('Ext.data.validations', {
         }
     },
     
-<span id='Ext-data.validations-method-format'>    /**
-</span>     * Returns true if the given value passes validation against the configured {@link #matcher} regex
-     * @param {Object} config Optional config object
+<span id='Ext-data-validations-method-email'>    /**
+</span>     * Validates that an email string is in the correct format
+     * @param {Object} config Config object
+     * @param {String} email The email address
+     * @return {Boolean} True if the value passes validation
+     */
+    email: function(config, email) {
+        return Ext.data.validations.emailRe.test(email);
+    },
+    
+<span id='Ext-data-validations-method-format'>    /**
+</span>     * Returns true if the given value passes validation against the configured `matcher` regex.
+     * For example:
+     *
+     *     validations: [{type: 'format', field: 'username', matcher: /([a-z]+)[0-9]{2,3}/}]
+     *
+     * @param {Object} config Config object
      * @param {String} value The value to validate
      * @return {Boolean} True if the value passes the format validation
      */
@@ -91,8 +135,13 @@ Ext.define('Ext.data.validations', {
         return !!(config.matcher &amp;&amp; config.matcher.test(value));
     },
     
-<span id='Ext-data.validations-method-inclusion'>    /**
-</span>     * Validates that the given value is present in the configured {@link #list}
+<span id='Ext-data-validations-method-inclusion'>    /**
+</span>     * Validates that the given value is present in the configured `list`.
+     * For example:
+     *
+     *     validations: [{type: 'inclusion', field: 'gender', list: ['Male', 'Female']}]
+     *
+     * @param {Object} config Config object
      * @param {String} value The value to validate
      * @return {Boolean} True if the value is present in the list
      */
@@ -100,13 +149,19 @@ Ext.define('Ext.data.validations', {
         return config.list &amp;&amp; Ext.Array.indexOf(config.list,value) != -1;
     },
     
-<span id='Ext-data.validations-method-exclusion'>    /**
-</span>     * Validates that the given value is present in the configured {@link #list}
-     * @param {Object} config Optional config object
+<span id='Ext-data-validations-method-exclusion'>    /**
+</span>     * Validates that the given value is present in the configured `list`.
+     * For example:
+     *
+     *     validations: [{type: 'exclusion', field: 'username', list: ['Admin', 'Operator']}]
+     *
+     * @param {Object} config Config object
      * @param {String} value The value to validate
      * @return {Boolean} True if the value is not present in the list
      */
     exclusion: function(config, value) {
         return config.list &amp;&amp; Ext.Array.indexOf(config.list,value) == -1;
     }
-});</pre></pre></body></html>
\ No newline at end of file
+});</pre>
+</body>
+</html>