docs/backbone-validation.html

<!DOCTYPE html>

<html>
<head>
  <title>backbone-validation.js</title>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  <link rel="stylesheet" media="all" href="docco.css" />
  <script type="text/javascript">
    var _gaq = _gaq || [];
    _gaq.push(['_setAccount', 'UA-12325477-1']);
    _gaq.push(['_trackPageview']);

    (function() {
      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    })();
  </script>
</head>
<body>
  <div id="container">
    <div id="background"></div>
    
    <ul class="sections">
        
          <li id="title">
              <div class="annotation">
                  <h1>backbone-validation.js</h1>
              </div>
          </li>
        
        
        
        <li id="section-1">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-1">&#182;</a>
              </div>
              <p>Backbone.Validation v0.11.1</p>
<p>Copyright (c) 2011-2015 Thomas Pedersen
Distributed under MIT License</p>
<p>Documentation and full license available at:
<a href="http://thedersen.com/projects/backbone-validation">http://thedersen.com/projects/backbone-validation</a></p>

            </div>
            
            <div class="content"><div class='highlight'><pre>Backbone.Validation = (<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(_)</span></span>{<span class="hljs-pi">
  'use strict'</span>;</pre></div></div>
            
        </li>
        
        
        <li id="section-2">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-2">&#182;</a>
              </div>
              <h2 id="default-options">Default options</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> defaultOptions = {
    forceUpdate: <span class="hljs-literal">false</span>,
    selector: <span class="hljs-string">'name'</span>,
    labelFormatter: <span class="hljs-string">'sentenceCase'</span>,
    valid: <span class="hljs-built_in">Function</span>.prototype,
    invalid: <span class="hljs-built_in">Function</span>.prototype
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-3">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-3">&#182;</a>
              </div>
              <h2 id="helper-functions">Helper functions</h2>

            </div>
            
        </li>
        
        
        <li id="section-4">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-4">&#182;</a>
              </div>
              <p>Formatting functions used for formatting error messages</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>  <span class="hljs-keyword">var</span> formatFunctions = {</pre></div></div>
            
        </li>
        
        
        <li id="section-5">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-5">&#182;</a>
              </div>
              <p>Uses the configured label formatter to format the attribute name
to make it more readable for the user</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    formatLabel: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attrName, model)</span> </span>{
      <span class="hljs-keyword">return</span> defaultLabelFormatters[defaultOptions.labelFormatter](attrName, model);
    },</pre></div></div>
            
        </li>
        
        
        <li id="section-6">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-6">&#182;</a>
              </div>
              <p>Replaces nummeric placeholders like {0} in a string with arguments
passed to the function</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    format: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span> </span>{
      <span class="hljs-keyword">var</span> args = <span class="hljs-built_in">Array</span>.prototype.slice.call(<span class="hljs-built_in">arguments</span>),
          text = args.shift();
      <span class="hljs-keyword">return</span> text.replace(<span class="hljs-regexp">/\{(\d+)\}/g</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(match, number)</span> </span>{
        <span class="hljs-keyword">return</span> <span class="hljs-keyword">typeof</span> args[number] !== <span class="hljs-string">'undefined'</span> ? args[number] : match;
      });
    }
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-7">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-7">&#182;</a>
              </div>
              <p>Flattens an object
eg:</p>
<pre><code><span class="hljs-keyword">var</span> o = {
  owner: {
    name: <span class="hljs-string">'Backbone'</span>,
    address: {
      street: <span class="hljs-string">'Street'</span>,
      zip: <span class="hljs-number">1234</span>
    }
  }
};
</code></pre><p>becomes:</p>
<pre><code><span class="hljs-keyword">var</span> o = {
  <span class="hljs-string">'owner'</span>: {
    name: <span class="hljs-string">'Backbone'</span>,
    address: {
      street: <span class="hljs-string">'Street'</span>,
      zip: <span class="hljs-number">1234</span>
    }
  },
  <span class="hljs-string">'owner.name'</span>: <span class="hljs-string">'Backbone'</span>,
  <span class="hljs-string">'owner.address'</span>: {
    street: <span class="hljs-string">'Street'</span>,
    zip: <span class="hljs-number">1234</span>
  },
  <span class="hljs-string">'owner.address.street'</span>: <span class="hljs-string">'Street'</span>,
  <span class="hljs-string">'owner.address.zip'</span>: <span class="hljs-number">1234</span>
};
</code></pre><p>This may seem redundant, but it allows for maximum flexibility
in validation rules.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>  <span class="hljs-keyword">var</span> flatten = <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(obj, into, prefix)</span> </span>{
    into = into || {};
    prefix = prefix || <span class="hljs-string">''</span>;

    _.each(obj, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(val, key)</span> </span>{
      <span class="hljs-keyword">if</span>(obj.hasOwnProperty(key)) {
        <span class="hljs-keyword">if</span> (!!val &amp;&amp; <span class="hljs-keyword">typeof</span> val === <span class="hljs-string">'object'</span> &amp;&amp; val.constructor === <span class="hljs-built_in">Object</span>) {
          flatten(val, into, prefix + key + <span class="hljs-string">'.'</span>);
        }</pre></div></div>
            
        </li>
        
        
        <li id="section-8">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-8">&#182;</a>
              </div>
              <p>Register the current level object as well</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>        into[prefix + key] = val;
      }
    });

    <span class="hljs-keyword">return</span> into;
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-9">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-9">&#182;</a>
              </div>
              <h2 id="validation">Validation</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> Validation = (<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span></span>{</pre></div></div>
            
        </li>
        
        
        <li id="section-10">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-10">&#182;</a>
              </div>
              <p>Returns an object with undefined properties for all
attributes on the model that has defined one or more
validation rules.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> getValidatedAttrs = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model, attrs)</span> </span>{
      attrs = attrs || _.keys(_.result(model, <span class="hljs-string">'validation'</span>) || {});
      <span class="hljs-keyword">return</span> _.reduce(attrs, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(memo, key)</span> </span>{
        memo[key] = <span class="hljs-keyword">void</span> <span class="hljs-number">0</span>;
        <span class="hljs-keyword">return</span> memo;
      }, {});
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-11">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-11">&#182;</a>
              </div>
              <p>Returns an array with attributes passed through options</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> getOptionsAttrs = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(options, view)</span> </span>{
      <span class="hljs-keyword">var</span> attrs = options.attributes;
      <span class="hljs-keyword">if</span> (_.isFunction(attrs)) {
        attrs = attrs(view);
      } <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> (_.isString(attrs) &amp;&amp; (_.isFunction(defaultAttributeLoaders[attrs]))) {
        attrs = defaultAttributeLoaders[attrs](view);
      }
      <span class="hljs-keyword">if</span> (_.isArray(attrs)) {
        <span class="hljs-keyword">return</span> attrs;
      }
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-12">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-12">&#182;</a>
              </div>
              <p>Looks on the model for validations for a specified
attribute. Returns an array of any validators defined,
or an empty array if none is defined.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> getValidators = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model, attr)</span> </span>{
      <span class="hljs-keyword">var</span> attrValidationSet = model.validation ? _.result(model, <span class="hljs-string">'validation'</span>)[attr] || {} : {};</pre></div></div>
            
        </li>
        
        
        <li id="section-13">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-13">&#182;</a>
              </div>
              <p>If the validator is a function or a string, wrap it in a function validator</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      <span class="hljs-keyword">if</span> (_.isFunction(attrValidationSet) || _.isString(attrValidationSet)) {
        attrValidationSet = {
          fn: attrValidationSet
        };
      }</pre></div></div>
            
        </li>
        
        
        <li id="section-14">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-14">&#182;</a>
              </div>
              <p>Stick the validator object into an array</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      <span class="hljs-keyword">if</span>(!_.isArray(attrValidationSet)) {
        attrValidationSet = [attrValidationSet];
      }</pre></div></div>
            
        </li>
        
        
        <li id="section-15">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-15">&#182;</a>
              </div>
              <p>Reduces the array of validators into a new array with objects
with a validation method to call, the value to validate against
and the specified error message, if any</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      <span class="hljs-keyword">return</span> _.reduce(attrValidationSet, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(memo, attrValidation)</span> </span>{
        _.each(_.without(_.keys(attrValidation), <span class="hljs-string">'msg'</span>), <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(validator)</span> </span>{
          memo.push({
            fn: defaultValidators[validator],
            val: attrValidation[validator],
            msg: attrValidation.msg
          });
        });
        <span class="hljs-keyword">return</span> memo;
      }, []);
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-16">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-16">&#182;</a>
              </div>
              <p>Validates an attribute against all validators defined
for that attribute. If one or more errors are found,
the first error message is returned.
If the attribute is valid, an empty string is returned.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> validateAttr = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model, attr, value, computed)</span> </span>{</pre></div></div>
            
        </li>
        
        
        <li id="section-17">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-17">&#182;</a>
              </div>
              <p>Reduces the array of validators to an error message by
applying all the validators and returning the first error
message, if any.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      <span class="hljs-keyword">return</span> _.reduce(getValidators(model, attr), <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(memo, validator)</span></span>{</pre></div></div>
            
        </li>
        
        
        <li id="section-18">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-18">&#182;</a>
              </div>
              <p>Pass the format functions plus the default
validators as the context to the validator</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>        <span class="hljs-keyword">var</span> ctx = _.extend({}, formatFunctions, defaultValidators),
            result = validator.fn.call(ctx, value, attr, validator.val, model, computed);

        <span class="hljs-keyword">if</span>(result === <span class="hljs-literal">false</span> || memo === <span class="hljs-literal">false</span>) {
          <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>;
        }
        <span class="hljs-keyword">if</span> (result &amp;&amp; !memo) {
          <span class="hljs-keyword">return</span> _.result(validator, <span class="hljs-string">'msg'</span>) || result;
        }
        <span class="hljs-keyword">return</span> memo;
      }, <span class="hljs-string">''</span>);
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-19">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-19">&#182;</a>
              </div>
              <p>Loops through the model’s attributes and validates the specified attrs.
Returns and object containing names of invalid attributes
as well as error messages.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> validateModel = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model, attrs, validatedAttrs)</span> </span>{
      <span class="hljs-keyword">var</span> error,
          invalidAttrs = {},
          isValid = <span class="hljs-literal">true</span>,
          computed = _.clone(attrs);

      _.each(validatedAttrs, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(val, attr)</span> </span>{
        error = validateAttr(model, attr, val, computed);
        <span class="hljs-keyword">if</span> (error) {
          invalidAttrs[attr] = error;
          isValid = <span class="hljs-literal">false</span>;
        }
      });

      <span class="hljs-keyword">return</span> {
        invalidAttrs: invalidAttrs,
        isValid: isValid
      };
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-20">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-20">&#182;</a>
              </div>
              <p>Contains the methods that are mixed in on the model when binding</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> mixin = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, options)</span> </span>{
      <span class="hljs-keyword">return</span> {</pre></div></div>
            
        </li>
        
        
        <li id="section-21">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-21">&#182;</a>
              </div>
              <p>Check whether or not a value, or a hash of values
passes validation without updating the model</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>        preValidate: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attr, value)</span> </span>{
          <span class="hljs-keyword">var</span> self = <span class="hljs-keyword">this</span>,
              result = {},
              error;

          <span class="hljs-keyword">if</span>(_.isObject(attr)){
            _.each(attr, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, key)</span> </span>{
              error = self.preValidate(key, value);
              <span class="hljs-keyword">if</span>(error){
                result[key] = error;
              }
            });

            <span class="hljs-keyword">return</span> _.isEmpty(result) ? <span class="hljs-literal">undefined</span> : result;
          }
          <span class="hljs-keyword">else</span> {
            <span class="hljs-keyword">return</span> validateAttr(<span class="hljs-keyword">this</span>, attr, value, _.extend({}, <span class="hljs-keyword">this</span>.attributes));
          }
        },</pre></div></div>
            
        </li>
        
        
        <li id="section-22">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-22">&#182;</a>
              </div>
              <p>Check to see if an attribute, an array of attributes or the
entire model is valid. Passing true will force a validation
of the model.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>        isValid: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(option)</span> </span>{
          <span class="hljs-keyword">var</span> flattened = flatten(<span class="hljs-keyword">this</span>.attributes);

         option = option || getOptionsAttrs(options, view);

          <span class="hljs-keyword">if</span>(_.isString(option)){
            <span class="hljs-keyword">return</span> !validateAttr(<span class="hljs-keyword">this</span>, option, flattened[option], _.extend({}, <span class="hljs-keyword">this</span>.attributes));
          }
          <span class="hljs-keyword">if</span>(_.isArray(option)){
            <span class="hljs-keyword">return</span> _.reduce(option, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(memo, attr)</span> </span>{
              <span class="hljs-keyword">return</span> memo &amp;&amp; !validateAttr(<span class="hljs-keyword">this</span>, attr, flattened[attr], _.extend({}, <span class="hljs-keyword">this</span>.attributes));
            }, <span class="hljs-literal">true</span>, <span class="hljs-keyword">this</span>);
          }
          <span class="hljs-keyword">if</span>(option === <span class="hljs-literal">true</span>) {
            <span class="hljs-keyword">this</span>.validate();
          }
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.validation ? <span class="hljs-keyword">this</span>._isValid : <span class="hljs-literal">true</span>;
        },</pre></div></div>
            
        </li>
        
        
        <li id="section-23">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-23">&#182;</a>
              </div>
              <p>This is called by Backbone when it needs to perform validation.
You can call it manually without any parameters to validate the
entire model.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>        validate: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attrs, setOptions)</span></span>{
          <span class="hljs-keyword">var</span> model = <span class="hljs-keyword">this</span>,
              validateAll = !attrs,
              opt = _.extend({}, options, setOptions),
              validatedAttrs = getValidatedAttrs(model, getOptionsAttrs(options, view)),
              allAttrs = _.extend({}, validatedAttrs, model.attributes, attrs),
              flattened = flatten(allAttrs),
              changedAttrs = attrs ? flatten(attrs) : flattened,
              result = validateModel(model, allAttrs, _.pick(flattened, _.keys(validatedAttrs)));

          model._isValid = result.isValid;</pre></div></div>
            
        </li>
        
        
        <li id="section-24">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-24">&#182;</a>
              </div>
              <p>After validation is performed, loop through all associated views</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>          _.each(model.associatedViews, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view)</span></span>{</pre></div></div>
            
        </li>
        
        
        <li id="section-25">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-25">&#182;</a>
              </div>
              <p>After validation is performed, loop through all validated and changed attributes
and call the valid and invalid callbacks so the view is updated.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>            _.each(validatedAttrs, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(val, attr)</span></span>{
                <span class="hljs-keyword">var</span> invalid = result.invalidAttrs.hasOwnProperty(attr),
                  changed = changedAttrs.hasOwnProperty(attr);

                <span class="hljs-keyword">if</span>(!invalid){
                  opt.valid(view, attr, opt.selector);
                }
                <span class="hljs-keyword">if</span>(invalid &amp;&amp; (changed || validateAll)){
                  opt.invalid(view, attr, result.invalidAttrs[attr], opt.selector);
                }
            });
          });</pre></div></div>
            
        </li>
        
        
        <li id="section-26">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-26">&#182;</a>
              </div>
              <p>Trigger validated events.
Need to defer this so the model is actually updated before
the event is triggered.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>          _.defer(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span> </span>{
            model.trigger(<span class="hljs-string">'validated'</span>, model._isValid, model, result.invalidAttrs);
            model.trigger(<span class="hljs-string">'validated:'</span> + (model._isValid ? <span class="hljs-string">'valid'</span> : <span class="hljs-string">'invalid'</span>), model, result.invalidAttrs);
          });</pre></div></div>
            
        </li>
        
        
        <li id="section-27">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-27">&#182;</a>
              </div>
              <p>Return any error messages to Backbone, unless the forceUpdate flag is set.
Then we do not return anything and fools Backbone to believe the validation was
a success. That way Backbone will update the model regardless.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>          <span class="hljs-keyword">if</span> (!opt.forceUpdate &amp;&amp; _.intersection(_.keys(result.invalidAttrs), _.keys(changedAttrs)).length &gt; <span class="hljs-number">0</span>) {
            <span class="hljs-keyword">return</span> result.invalidAttrs;
          }
        }
      };
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-28">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-28">&#182;</a>
              </div>
              <p>Helper to mix in validation on a model. Stores the view in the associated views array.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> bindModel = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, model, options)</span> </span>{
      <span class="hljs-keyword">if</span> (model.associatedViews) {
        model.associatedViews.push(view);
      } <span class="hljs-keyword">else</span> {
        model.associatedViews = [view];
      }
      _.extend(model, mixin(view, options));
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-29">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-29">&#182;</a>
              </div>
              <p>Removes view from associated views of the model or the methods
added to a model if no view or single view provided</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> unbindModel = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model, view)</span> </span>{
      <span class="hljs-keyword">if</span> (view &amp;&amp; model.associatedViews.length &gt; <span class="hljs-number">1</span>){
        model.associatedViews = _.without(model.associatedViews, view);
      } <span class="hljs-keyword">else</span> {
        <span class="hljs-keyword">delete</span> model.validate;
        <span class="hljs-keyword">delete</span> model.preValidate;
        <span class="hljs-keyword">delete</span> model.isValid;
        <span class="hljs-keyword">delete</span> model.associatedViews;
      }
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-30">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-30">&#182;</a>
              </div>
              <p>Mix in validation on a model whenever a model is
added to a collection</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> collectionAdd = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model)</span> </span>{
      bindModel(<span class="hljs-keyword">this</span>.view, model, <span class="hljs-keyword">this</span>.options);
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-31">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-31">&#182;</a>
              </div>
              <p>Remove validation from a model whenever a model is
removed from a collection</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> collectionRemove = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model)</span> </span>{
      unbindModel(model);
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-32">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-32">&#182;</a>
              </div>
              <p>Returns the public methods on Backbone.Validation</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">return</span> {</pre></div></div>
            
        </li>
        
        
        <li id="section-33">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-33">&#182;</a>
              </div>
              <p>Current version of the library</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      version: <span class="hljs-string">'0.9.1'</span>,</pre></div></div>
            
        </li>
        
        
        <li id="section-34">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-34">&#182;</a>
              </div>
              <p>Called to configure the default options</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      configure: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(options)</span> </span>{
        _.extend(defaultOptions, options);
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-35">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-35">&#182;</a>
              </div>
              <p>Hooks up validation on a view with a model
or collection</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      bind: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, options)</span> </span>{
        options = _.extend({}, defaultOptions, defaultCallbacks, options);

        <span class="hljs-keyword">var</span> model = options.model || view.model,
            collection = options.collection || view.collection;

        <span class="hljs-keyword">if</span>(<span class="hljs-keyword">typeof</span> model === <span class="hljs-string">'undefined'</span> &amp;&amp; <span class="hljs-keyword">typeof</span> collection === <span class="hljs-string">'undefined'</span>){
          <span class="hljs-keyword">throw</span> <span class="hljs-string">'Before you execute the binding your view must have a model or a collection.\n'</span> +
                <span class="hljs-string">'See http://thedersen.com/projects/backbone-validation/#using-form-model-validation for more information.'</span>;
        }

        <span class="hljs-keyword">if</span>(model) {
          bindModel(view, model, options);
        }
        <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span>(collection) {
          collection.each(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model)</span></span>{
            bindModel(view, model, options);
          });
          collection.bind(<span class="hljs-string">'add'</span>, collectionAdd, {view: view, options: options});
          collection.bind(<span class="hljs-string">'remove'</span>, collectionRemove);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-36">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-36">&#182;</a>
              </div>
              <p>Removes validation from a view with a model
or collection</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      unbind: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, options)</span> </span>{
        options = _.extend({}, options);
        <span class="hljs-keyword">var</span> model = options.model || view.model,
            collection = options.collection || view.collection;

        <span class="hljs-keyword">if</span>(model) {
          unbindModel(model, view);
        }
        <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span>(collection) {
          collection.each(<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(model)</span></span>{
            unbindModel(model, view);
          });
          collection.unbind(<span class="hljs-string">'add'</span>, collectionAdd);
          collection.unbind(<span class="hljs-string">'remove'</span>, collectionRemove);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-37">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-37">&#182;</a>
              </div>
              <p>Used to extend the Backbone.Model.prototype
with validation</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      mixin: mixin(<span class="hljs-literal">null</span>, defaultOptions)
    };
  }());</pre></div></div>
            
        </li>
        
        
        <li id="section-38">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-38">&#182;</a>
              </div>
              <h2 id="callbacks">Callbacks</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> defaultCallbacks = Validation.callbacks = {</pre></div></div>
            
        </li>
        
        
        <li id="section-39">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-39">&#182;</a>
              </div>
              <p>Gets called when a previously invalid field in the
view becomes valid. Removes any error message.
Should be overridden with custom functionality.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    valid: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, attr, selector)</span> </span>{
      view.$(<span class="hljs-string">'['</span> + selector + <span class="hljs-string">'~="'</span> + attr + <span class="hljs-string">'"]'</span>)
          .removeClass(<span class="hljs-string">'invalid'</span>)
          .removeAttr(<span class="hljs-string">'data-error'</span>);
    },</pre></div></div>
            
        </li>
        
        
        <li id="section-40">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-40">&#182;</a>
              </div>
              <p>Gets called when a field in the view becomes invalid.
Adds a error message.
Should be overridden with custom functionality.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    invalid: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(view, attr, error, selector)</span> </span>{
      view.$(<span class="hljs-string">'['</span> + selector + <span class="hljs-string">'~="'</span> + attr + <span class="hljs-string">'"]'</span>)
          .addClass(<span class="hljs-string">'invalid'</span>)
          .attr(<span class="hljs-string">'data-error'</span>, error);
    }
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-41">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-41">&#182;</a>
              </div>
              <h2 id="patterns">Patterns</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> defaultPatterns = Validation.patterns = {</pre></div></div>
            
        </li>
        
        
        <li id="section-42">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-42">&#182;</a>
              </div>
              <p>Matches any digit(s) (i.e. 0-9)</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    digits: <span class="hljs-regexp">/^\d+$/</span>,</pre></div></div>
            
        </li>
        
        
        <li id="section-43">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-43">&#182;</a>
              </div>
              <p>Matches any number (e.g. 100.000)</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    number: <span class="hljs-regexp">/^-?(?:\d+|\d{1,3}(?:,\d{3})+)(?:\.\d+)?$/</span>,</pre></div></div>
            
        </li>
        
        
        <li id="section-44">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-44">&#182;</a>
              </div>
              <p>Matches a valid email address (e.g. mail@example.com)</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    email: <span class="hljs-regexp">/^((([a-z]|\d|[!#\$%&amp;'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&amp;'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$/i</span>,</pre></div></div>
            
        </li>
        
        
        <li id="section-45">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-45">&#182;</a>
              </div>
              <p>Mathes any valid url (e.g. <a href="http://www.xample.com">http://www.xample.com</a>)</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    url: <span class="hljs-regexp">/^(https?|ftp):\/\/(((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&amp;'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&amp;'\(\)\*\+,;=]|:|@)+(\/(([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&amp;'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&amp;'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(\#((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&amp;'\(\)\*\+,;=]|:|@)|\/|\?)*)?$/i</span>
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-46">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-46">&#182;</a>
              </div>
              <h2 id="error-messages">Error messages</h2>

            </div>
            
        </li>
        
        
        <li id="section-47">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-47">&#182;</a>
              </div>
              <p>Error message for the build in validators.
{x} gets swapped out with arguments form the validator.</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>  <span class="hljs-keyword">var</span> defaultMessages = Validation.messages = {
    required: <span class="hljs-string">'{0} is required'</span>,
    acceptance: <span class="hljs-string">'{0} must be accepted'</span>,
    min: <span class="hljs-string">'{0} must be greater than or equal to {1}'</span>,
    max: <span class="hljs-string">'{0} must be less than or equal to {1}'</span>,
    range: <span class="hljs-string">'{0} must be between {1} and {2}'</span>,
    length: <span class="hljs-string">'{0} must be {1} characters'</span>,
    minLength: <span class="hljs-string">'{0} must be at least {1} characters'</span>,
    maxLength: <span class="hljs-string">'{0} must be at most {1} characters'</span>,
    rangeLength: <span class="hljs-string">'{0} must be between {1} and {2} characters'</span>,
    oneOf: <span class="hljs-string">'{0} must be one of: {1}'</span>,
    equalTo: <span class="hljs-string">'{0} must be the same as {1}'</span>,
    digits: <span class="hljs-string">'{0} must only contain digits'</span>,
    number: <span class="hljs-string">'{0} must be a number'</span>,
    email: <span class="hljs-string">'{0} must be a valid email'</span>,
    url: <span class="hljs-string">'{0} must be a valid url'</span>,
    inlinePattern: <span class="hljs-string">'{0} is invalid'</span>
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-48">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-48">&#182;</a>
              </div>
              <h2 id="label-formatters">Label formatters</h2>

            </div>
            
        </li>
        
        
        <li id="section-49">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-49">&#182;</a>
              </div>
              <p>Label formatters are used to convert the attribute name
to a more human friendly label when using the built in
error messages.
Configure which one to use with a call to</p>
<pre><code>Backbone.Validation.configure({
  labelFormatter: <span class="hljs-string">'label'</span>
});
</code></pre>
            </div>
            
            <div class="content"><div class='highlight'><pre>  <span class="hljs-keyword">var</span> defaultLabelFormatters = Validation.labelFormatters = {</pre></div></div>
            
        </li>
        
        
        <li id="section-50">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-50">&#182;</a>
              </div>
              <p>Returns the attribute name with applying any formatting</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    none: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attrName)</span> </span>{
      <span class="hljs-keyword">return</span> attrName;
    },</pre></div></div>
            
        </li>
        
        
        <li id="section-51">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-51">&#182;</a>
              </div>
              <p>Converts attributeName or attribute_name to Attribute name</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    sentenceCase: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attrName)</span> </span>{
      <span class="hljs-keyword">return</span> attrName.replace(<span class="hljs-regexp">/(?:^\w|[A-Z]|\b\w)/g</span>, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(match, index)</span> </span>{
        <span class="hljs-keyword">return</span> index === <span class="hljs-number">0</span> ? match.toUpperCase() : <span class="hljs-string">' '</span> + match.toLowerCase();
      }).replace(<span class="hljs-regexp">/_/g</span>, <span class="hljs-string">' '</span>);
    },</pre></div></div>
            
        </li>
        
        
        <li id="section-52">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-52">&#182;</a>
              </div>
              <p>Looks for a label configured on the model and returns it</p>
<pre><code> <span class="hljs-keyword">var</span> Model = Backbone.Model.extend({
   validation: {
     someAttribute: {
       required: <span class="hljs-literal">true</span>
     }
   },

   labels: {
     someAttribute: <span class="hljs-string">'Custom label'</span>
   }
 });
</code></pre>
            </div>
            
            <div class="content"><div class='highlight'><pre>    label: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(attrName, model)</span> </span>{
      <span class="hljs-keyword">return</span> (model.labels &amp;&amp; model.labels[attrName]) || defaultLabelFormatters.sentenceCase(attrName, model);
    }
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-53">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-53">&#182;</a>
              </div>
              <p>AttributeLoaders</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> defaultAttributeLoaders = Validation.attributeLoaders = {
    inputNames: <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">(view)</span> </span>{
      <span class="hljs-keyword">var</span> attrs = [];
      <span class="hljs-keyword">if</span> (view) {
        view.$(<span class="hljs-string">'form [name]'</span>).each(<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-params">()</span> </span>{
          <span class="hljs-keyword">if</span> (<span class="hljs-regexp">/^(?:input|select|textarea)$/i</span>.test(<span class="hljs-keyword">this</span>.nodeName) &amp;&amp; <span class="hljs-keyword">this</span>.name &amp;&amp;
            <span class="hljs-keyword">this</span>.type !== <span class="hljs-string">'submit'</span> &amp;&amp; attrs.indexOf(<span class="hljs-keyword">this</span>.name) === -<span class="hljs-number">1</span>) {
            attrs.push(<span class="hljs-keyword">this</span>.name);
          }
        });
      }
      <span class="hljs-keyword">return</span> attrs;
    }
  };</pre></div></div>
            
        </li>
        
        
        <li id="section-54">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-54">&#182;</a>
              </div>
              <h2 id="built-in-validators">Built in validators</h2>

            </div>
            
            <div class="content"><div class='highlight'><pre>
  <span class="hljs-keyword">var</span> defaultValidators = Validation.validators = (<span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">()</span></span>{</pre></div></div>
            
        </li>
        
        
        <li id="section-55">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-55">&#182;</a>
              </div>
              <p>Use native trim when defined</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> trim = <span class="hljs-built_in">String</span>.prototype.trim ?
      <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(text)</span> </span>{
        <span class="hljs-keyword">return</span> text === <span class="hljs-literal">null</span> ? <span class="hljs-string">''</span> : <span class="hljs-built_in">String</span>.prototype.trim.call(text);
      } :
      <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(text)</span> </span>{
        <span class="hljs-keyword">var</span> trimLeft = <span class="hljs-regexp">/^\s+/</span>,
            trimRight = <span class="hljs-regexp">/\s+$/</span>;

        <span class="hljs-keyword">return</span> text === <span class="hljs-literal">null</span> ? <span class="hljs-string">''</span> : text.toString().replace(trimLeft, <span class="hljs-string">''</span>).replace(trimRight, <span class="hljs-string">''</span>);
      };</pre></div></div>
            
        </li>
        
        
        <li id="section-56">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-56">&#182;</a>
              </div>
              <p>Determines whether or not a value is a number</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> isNumber = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value)</span></span>{
      <span class="hljs-keyword">return</span> _.isNumber(value) || (_.isString(value) &amp;&amp; value.match(defaultPatterns.number));
    };</pre></div></div>
            
        </li>
        
        
        <li id="section-57">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-57">&#182;</a>
              </div>
              <p>Determines whether or not a value is empty</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>    <span class="hljs-keyword">var</span> hasValue = <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value)</span> </span>{
      <span class="hljs-keyword">return</span> !(_.isNull(value) || _.isUndefined(value) || (_.isString(value) &amp;&amp; trim(value) === <span class="hljs-string">''</span>) || (_.isArray(value) &amp;&amp; _.isEmpty(value)));
    };

    <span class="hljs-keyword">return</span> {</pre></div></div>
            
        </li>
        
        
        <li id="section-58">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-58">&#182;</a>
              </div>
              <p>Function validator
Lets you implement a custom function used for validation</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      fn: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, fn, model, computed)</span> </span>{
        <span class="hljs-keyword">if</span>(_.isString(fn)){
          fn = model[fn];
        }
        <span class="hljs-keyword">return</span> fn.call(model, value, attr, computed);
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-59">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-59">&#182;</a>
              </div>
              <p>Required validator
Validates if the attribute is required or not
This can be specified as either a boolean value or a function that returns a boolean value</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      required: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, required, model, computed)</span> </span>{
        <span class="hljs-keyword">var</span> isRequired = _.isFunction(required) ? required.call(model, value, attr, computed) : required;
        <span class="hljs-keyword">if</span>(!isRequired &amp;&amp; !hasValue(value)) {
          <span class="hljs-keyword">return</span> <span class="hljs-literal">false</span>; <span class="hljs-comment">// overrides all other validators</span>
        }
        <span class="hljs-keyword">if</span> (isRequired &amp;&amp; !hasValue(value)) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.required, <span class="hljs-keyword">this</span>.formatLabel(attr, model));
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-60">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-60">&#182;</a>
              </div>
              <p>Acceptance validator
Validates that something has to be accepted, e.g. terms of use
<code>true</code> or ‘true’ are valid</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      acceptance: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, accept, model)</span> </span>{
        <span class="hljs-keyword">if</span>(value !== <span class="hljs-string">'true'</span> &amp;&amp; (!_.isBoolean(value) || value === <span class="hljs-literal">false</span>)) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.acceptance, <span class="hljs-keyword">this</span>.formatLabel(attr, model));
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-61">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-61">&#182;</a>
              </div>
              <p>Min validator
Validates that the value has to be a number and equal to or greater than
the min value specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      min: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, minValue, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!isNumber(value) || value &lt; minValue) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.min, <span class="hljs-keyword">this</span>.formatLabel(attr, model), minValue);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-62">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-62">&#182;</a>
              </div>
              <p>Max validator
Validates that the value has to be a number and equal to or less than
the max value specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      max: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, maxValue, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!isNumber(value) || value &gt; maxValue) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.max, <span class="hljs-keyword">this</span>.formatLabel(attr, model), maxValue);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-63">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-63">&#182;</a>
              </div>
              <p>Range validator
Validates that the value has to be a number and equal to or between
the two numbers specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      range: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, range, model)</span> </span>{
        <span class="hljs-keyword">if</span>(!isNumber(value) || value &lt; range[<span class="hljs-number">0</span>] || value &gt; range[<span class="hljs-number">1</span>]) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.range, <span class="hljs-keyword">this</span>.formatLabel(attr, model), range[<span class="hljs-number">0</span>], range[<span class="hljs-number">1</span>]);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-64">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-64">&#182;</a>
              </div>
              <p>Length validator
Validates that the value has to be a string with length equal to
the length value specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      length: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, length, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!_.isString(value) || value.length !== length) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.length, <span class="hljs-keyword">this</span>.formatLabel(attr, model), length);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-65">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-65">&#182;</a>
              </div>
              <p>Min length validator
Validates that the value has to be a string with length equal to or greater than
the min length value specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      minLength: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, minLength, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!_.isString(value) || value.length &lt; minLength) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.minLength, <span class="hljs-keyword">this</span>.formatLabel(attr, model), minLength);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-66">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-66">&#182;</a>
              </div>
              <p>Max length validator
Validates that the value has to be a string with length equal to or less than
the max length value specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      maxLength: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, maxLength, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!_.isString(value) || value.length &gt; maxLength) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.maxLength, <span class="hljs-keyword">this</span>.formatLabel(attr, model), maxLength);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-67">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-67">&#182;</a>
              </div>
              <p>Range length validator
Validates that the value has to be a string and equal to or between
the two numbers specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      rangeLength: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, range, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!_.isString(value) || value.length &lt; range[<span class="hljs-number">0</span>] || value.length &gt; range[<span class="hljs-number">1</span>]) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.rangeLength, <span class="hljs-keyword">this</span>.formatLabel(attr, model), range[<span class="hljs-number">0</span>], range[<span class="hljs-number">1</span>]);
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-68">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-68">&#182;</a>
              </div>
              <p>One of validator
Validates that the value has to be equal to one of the elements in
the specified array. Case sensitive matching</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      oneOf: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, values, model)</span> </span>{
        <span class="hljs-keyword">if</span>(!_.include(values, value)){
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.oneOf, <span class="hljs-keyword">this</span>.formatLabel(attr, model), values.join(<span class="hljs-string">', '</span>));
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-69">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-69">&#182;</a>
              </div>
              <p>Equal to validator
Validates that the value has to be equal to the value of the attribute
with the name specified</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      equalTo: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, equalTo, model, computed)</span> </span>{
        <span class="hljs-keyword">if</span>(value !== computed[equalTo]) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages.equalTo, <span class="hljs-keyword">this</span>.formatLabel(attr, model), <span class="hljs-keyword">this</span>.formatLabel(equalTo, model));
        }
      },</pre></div></div>
            
        </li>
        
        
        <li id="section-70">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-70">&#182;</a>
              </div>
              <p>Pattern validator
Validates that the value has to match the pattern specified.
Can be a regular expression or the name of one of the built in patterns</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>      pattern: <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(value, attr, pattern, model)</span> </span>{
        <span class="hljs-keyword">if</span> (!hasValue(value) || !value.toString().match(defaultPatterns[pattern] || pattern)) {
          <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.format(defaultMessages[pattern] || defaultMessages.inlinePattern, <span class="hljs-keyword">this</span>.formatLabel(attr, model), pattern);
        }
      }
    };
  }());</pre></div></div>
            
        </li>
        
        
        <li id="section-71">
            <div class="annotation">
              
              <div class="pilwrap ">
                <a class="pilcrow" href="#section-71">&#182;</a>
              </div>
              <p>Set the correct context for all validators
when used from within a method validator</p>

            </div>
            
            <div class="content"><div class='highlight'><pre>  _.each(defaultValidators, <span class="hljs-function"><span class="hljs-keyword">function</span><span class="hljs-params">(validator, key)</span></span>{
    defaultValidators[key] = _.bind(defaultValidators[key], _.extend({}, formatFunctions, defaultValidators));
  });

  <span class="hljs-keyword">return</span> Validation;
}(_));</pre></div></div>
            
        </li>
        
    </ul>
  </div>
</body>
</html>