---

Classes

• _global_
• validanguage
• validanguage.settings

---

Namespace validanguage

Global validanguage object The validanguage library was written by DrLongGhost in 2008. See attached MIT_License.js and readme.txt for licensing and documentation. Visit http://www.drlongghost.com/validanguage.php for updates.
Defined in: validanguage_uncompressed.js.

Namespace Summary

Constructor Attributes	Constructor Name and Description
	validanguage The validanguage library was written by DrLongGhost in 2008.

Field Summary

Field Attributes	Field Name and Description
<static>	validanguage.useLibrary Valid values are 'none', 'dojo', 'jquery', 'prototype', and 'scriptaculous'.

Method Summary

Method Attributes	Method Name and Description
<static>	validanguage.$(DomNode) Omnipresent dollar function.
<static>	validanguage.addEvent(Object, Event, Function) Generic cross-browser addEvent() function.
<static>	validanguage.addEventInit() Reassigns the validanguage.addEvent function, if an external library is being used.
<static>	validanguage.addOrCreateValidationWrapper(Form, eventType,, validationsCounter,) This function wraps multiple validanguage.el.elemId.validations event handlers and transformations within a single wrapper to call all loaded validations/transformations and exit as soon as a validation returns false.
<static>	validanguage.addValidation(elemId, eventTypes, validationNames) This function is used to either load a new validation for a form field, or to reactivate a validation previously removed with the removeValidation() method.
<static>	validanguage.ajax(url, callback) Very simple AJAX function
<static>	validanguage.ajaxInit() Initializes validanguage.ajax as browser-specific
<static>	validanguage.ajaxValidationWrapper(ID, Event) This function is called by setInterval and is used to check whether or not all ajax callbacks for a form have returned.
<static>	validanguage.callToggleTransformationsOnload() This function loads all the validanguage.toggle() rules which are defined for a form following document.onload()
<static>	validanguage.concatCollection(obj1, obj2) Combines 2 node lists into 1
<static>	validanguage.contains(node, node) Determines whether the passed domNode is contained within the passed parentNode.
<static>	validanguage.empty(testVar, falseIsEmpty) Emulates PHP's empty() function.
<static>	validanguage.format(Pattern, String, Regular) This is a preset transformation which is used to reformat text input to match a desired pattern
<static>	validanguage.getAjaxLookupIndex(element, counter) This function iterates thru the ajaxLookup array and returns the index number corresponding to the passed counter value
<static>	validanguage.getCaretPos(obj) Gets the current caret position on an object
<static>	validanguage.getComments(el) Fetches all comment nodes in the passed form node and returns them in a node list Doesnt work in konqueror, since konqueror strips all comments from the DOM
<static>	validanguage.getDateTimeDefaultOptions(options, defaults) Helper function used by validateDate() and validateTimestamp().
<static>	validanguage.getElSetting(Name, ID) This function checks for a given setting in increasing specificity within the validanguage.forms[formId].settings object, and within the passed validanguage.el objects
<static>	validanguage.getFormId(Form) This function returns the Id of the parent Form for an element
<static>	validanguage.getFormSettings(id) This function returns the validanguage.form[formId].setting object for the passed element ID
<static>	validanguage.getSettingFromComment(Name, Full) This function parses the passed comment to retrieve the indicated setting
<static>	validanguage.hideError() This function hides the div containing the validanguage error messages for failed validations
<static>	validanguage.inArray(needle, haystack) Determines whether the passed item is present in the array or object.
<static>	validanguage.inheritIfDefined(settingsHaystack, settingsNeedles, settingsTarget, constrainType) This function searches settingsHaystack for all variables defined in the settingsNeedles array, and if they are located, they are copied over to the settingsTarget
<static>	validanguage.init() Initialization function for validanguage.
<static>	validanguage.insertAfter(nodeToAdd, referenceNode) Function to insert 1 Node after another in the DOM.
<static>	validanguage.isExpiredAjax(formFieldId, ajaxCounter) This function examines the ajaxLookup array to determine whether or not the specified ajaxCounter pertains to the most recent ajax call for that form field.
<static>	validanguage.loadCommentAPI(Dom, For) This function parses all comments in the current document, looking for the comment-based API and converts any validanguage statements it finds into the element/json-based API for further processing.
<static>	validanguage.loadElAPI((Optional)) This function parses the validanguage.el object to load all the form-element-specific validation settings which the end user has defined via the Object-based API
<static>	validanguage.loadForm(form) This function loads a form and its settings into the global validanguage object so it can receive validation criteria.
<static>	validanguage.loadNewFields(containingElement) This function loads all the validation rules specified within the passed element.
<static>	validanguage.parseSubstring(startChar, endChar, subject) This function searches the passed subject and returns an Array of strings which are delimited by the characters passed to the function in the first 2 arguments.
<static>	validanguage.populate() Main function to be called onload to load all the validations
<static>	validanguage.remainingChars() This transformation function updates a div or span with the total number of characters remaining, based on a comparison between the number of characters the user has typed and the defined minLength and maxLength values for the field.
<static>	validanguage.removeAllValidations(Containing) This function will remove all the validations for any form fields contained within the passed containing element.
<static>	validanguage.removeForm(Which) This function removes all references to a form and its elements from the global validanguage object
<static>	validanguage.removeValidation(elemId, eventTypes, validationNames) This function is used to deactivate a previously loaded validation.
<static>	validanguage.resolveArray(args, returnType, ignoreCommas) This function accepts as input a function, a string, an array of functions, an array of strings, or a comma-delimited list of functon names as its argument and returns an Array of functions or strings comprising the passed arguments.
<static>	validanguage.setCaretPos(Dom, Position) Sets the caret at a specified position on an object
<static>	validanguage.setValidationStatus(id, returnStatus, type, errorMsg) This function is called from an ajax callback to report back to validanguage the status of the ajax validation.
<static>	validanguage.showError(Text) This function shows the error messages for failed validations by dynamically creating a div
<static>	validanguage.showSubmitMessage(validationResult, failedValidations) This function is intended for us as an onsubmit transformation.
<static>	validanguage.smartCommaSplit(Comma-delimited) This function splits a string into an array using commas as the delimiter, while being smart enough to ignore commas appearing inside parenthesis and braces.
<static>	validanguage.sniffBrowser() Determines roughly which browser they're using.
<static>	validanguage.stripWhitespace() This function will strip all the leading and trailing whitespace from a form field prior to its being validated.
<static>	validanguage.substituteText(Array, Array) This function replaces one subset of text with a different subset of text, such as making all uppercase letters, lowercase.
<static>	validanguage.toggle(toggleArgs) Transformation supporting 3 major features: toggling visibility, changing the values of form fields and adding options to select elements.
<static>	validanguage.toggleCriteriaMet(field, criteria, settings) Determines whether the criteria used by the toggle function has been met
<static>	validanguage.toggleDisplay(nodeId, visibility) Function used to hide or show a node.
<static>	validanguage.trim() Transformation function which strips all leading and trailing whitespace from a form field prior to validation.
<static>	validanguage.validateCharacters(text) Validates that a field does not contain any of the invalid characters listed in the characters validation rules.
<static>	validanguage.validateCreditCard(text, cardTypes, testChecksum) Validates that a valid credit card number has been supplied
<static>	validanguage.validateDate(text, Options) Validates that a valid date is supplied and is entered in the correct format.
<static>	validanguage.validateDateExists(year,, month, day) Helper function to verify a date actually exists.
<static>	validanguage.validateEmail(text) Validates an email address
<static>	validanguage.validateForm(Form) Calls the validationWrapper function on the passed form ID
<static>	validanguage.validateIP(text) Validates that a field contains a valid IPv4 address
<static>	validanguage.validateKeypress(e) Function to suppress the keys specified in validanguage.el.characters from being entered into a textarea or text box.
<static>	validanguage.validateMaxlength(text, max) Validates that a field is less than maxlength characters long
<static>	validanguage.validateMinlength(text, min) Validates that a field is greater than minlength characters long
<static>	validanguage.validateNumeric(text) Validates that a field is numeric
<static>	validanguage.validatePasswordStrength(text, Argument) Validates whether a password is adequately secure.
<static>	validanguage.validateRegex(text, optional) Validates the element against a user-defined regex stored in validanguage.el[id].regex.
<static>	validanguage.validateRequired(text) Validates whether or not an element has been filled out, selected or checked.
<static>	validanguage.validateRequiredAlternatives(e) This function calls the validateRequired method on the "master/required" form field when the "alternative" form field is clicked and then calls the appropriate onerorr/onsuccess function.
<static>	validanguage.validateRequiredChild(text) Child function called by validateRequired to validates whether or not an element has been filled out, selected or checked.
<static>	validanguage.validateTimestamp(text, Options) Validates that the entered text is a valid timestamp.
<static>	validanguage.validateURL(text) Validates a URL
<static>	validanguage.validateUSPhoneNumber(text) Validates that a US Phone number is entered
<static>	validanguage.validateUSSSN(text) Validates that a US Social Security Number is entered
<static>	validanguage.validateUSZipCode(text) Validates that a US zip code was entered
<static>	validanguage.validationWrapper(Event, Custom, ajaxLookupIndex) This is a wrapper for all the validation event handlers assigned to both form field element and to forms themselves.

Default Value:

'none'

Parameters:

{String|DomNode} DomNode

or its ID

---

Parameters:

{Object} Object

to receive the event

{Object} Event

type

{Object} Function

to be called

---

---

Parameters:

{Object} Form

element object

{string} eventType,

such as "blur" or "keydown"

{integer} validationsCounter,

denotes the array index of this item in validanguage.el.elemId.validations

---

Parameters:

{String} elemId

{String/Array} eventTypes

{String/Array/Function} validationNames

---

Parameters:

{String} url

{Function} callback

---

---

Parameters:

{String} ID

or index of the form

{String} Event

Type

---

---

Parameters:

{Object} obj1

{Object} obj2

---

Parameters:

{Object|String} node

or ID

{Object|String} node

or ID

---

Parameters:

{Object} testVar

{bool} falseIsEmpty

---

Parameters:

{String} Pattern

using x to represent alphanumeric characters. For example: "(xxx) xxx-xxxx"

{String} String

listing any characters to be removed from the form field's value prior to potential reformatting. INCLUDE ALL the delimiters used in "pattern" For example: "()- "

{String/Regex} Regular

expression which, if provided, will be used to determine whether or not to proceed with reformatting. If not provided, the function will only reformat if the number of characters in the form field (after stripThese is applied) matches the number of x's in the provided pattern

---

Parameters:

{String} element

ID

{Object} counter

---

Parameters:

{Object} obj

---

Parameters:

{Containing Node} el

---

Parameters:

{Object} options

object provided by the user to validateDate() or validateTimestamp().

{Object} defaults

which should be used. Used to allow validateDate() and validateTimestamp() to have different default dateOrder values.

---

Parameters:

{string} Name

of the setting to be retrieved

{string} ID

of the form field object being validated

{Object} validanguage.el.objId.validations[index]

object

---

Parameters:

{String|DomNode} Form

node or its ID

---

Parameters:

{string or Node} id

of the input field or input node

Returns:

{Object} settings object

---

Parameters:

{String} Name

of the setting to retrieve / needle

{String} Full

text of the HTML comment / haystack

Returns:

{String} The value of the requested setting

---

---

Parameters:

{Object} needle

{Object} haystack

---

Parameters:

{Object} settingsHaystack

-- Object location to be searched for settings

{Array} settingsNeedles

-- Array of settings to be checked

{Object} settingsTarget

-- Object location where any defined settings should be copied to

{String} constrainType

-- Optional type constraint

---

---

Parameters:

{Node} nodeToAdd

{Node} referenceNode

---

Parameters:

{String} formFieldId

{Integer} ajaxCounter

---

Parameters:

{Object} Dom

Node containing comments to be loaded

{Array} For

konqueror, we pass this function an Array with all the comments (retrieved via AJAX) For all other browsers, konquerorComments is undefined and we retrieve the comments normally via the DOM

---

Parameters:

{String|Object} (Optional)

If provided, this is either a DOM node or a node's ID. Providing a DOM node will limit the function to loading validations for only elements contained within that node, or if the node is a form field itself, limit to only that field.

---

Parameters:

{String|Object} form

Node or ID of the form

---

Parameters:

{String|DomNode} containingElement

or its ID

---

Parameters:

{String} startChar

{String} endChar

{String} subject

Returns:

{Array}

---

---

---

Parameters:

{String|DomNode} Containing

element or its ID

---

Parameters:

{String|DomNode} Which

form to remove

---

Parameters:

{String} elemId

{String/Array} eventTypes

{String/Array/Function} validationNames

---

Parameters:

{Function or String or Array} args

{String} returnType

should be either 'string' or 'function'

ignoreCommas

Returns:

{Array of Functions}

---

Parameters:

{Object} Dom

Node

{Object} Position

---

Parameters:

{Object} id

Id of the form field associated with this validation

{Boolean} returnStatus

Whether or not the field is valid

{String|Integer} type

Event Type or (alternately) the ajaxCounter that can be used to check validanguage.ajaxLookup to determine the eventType

{String} errorMsg

Error message to show for the failed field

---

Parameters:

{string} Text

of the error message to be displayed

---

Parameters:

{Object} validationResult

{Object} failedValidations

---

Parameters:

{string} Comma-delimited

string

Returns:

{Array}

---

---

---

Parameters:

{Array|String} Array

of characters to replace or either "upper" or "lower"

{Array|String} Array

of characters used for replacements or either "upper" or "lower"

---

Parameters:

{Array} toggleArgs

Array of objects

---

Parameters:

{Object} field

{string} criteria

{Object} settings

object

---

Parameters:

{Object} nodeId

ID of the node to hide/show

{Object} visibility

(optional) Pass either 'none' or '' to hide/show. Or leave blank to toggle

---

---

Parameters:

{string} text

---

Parameters:

{string} text

{array} cardTypes

{boolean} testChecksum

Pass false to skip the luhn checksum test

---

Parameters:

{String} text

to be validated

{Object} Options

object containing any of the following options
dateOrder: {String} This must be either 'ymd','mdy','dmy','myd','ydm', or 'dym
allowedDelimiters: {String}. A string containing the list of delimiters which are allowed. Example: './-'
twoDigitYearsAllowed: {Boolean}. Is a 2-digit year valid
oneDigitDaysAndMonthsAllowed: {Boolean}. Is a 1-digit month or a 1-digit day valid
maxYear: {Integer}. Years greater than maxYear will be treated as invalid. Defaults to 15 years from today
minYear: {Integer}. Years less than minYear will be treated as invalid. Defaults to 1900
rejectDatesInTheFuture: {Boolean}. Are dates in the future valid? rejectDatesInTheFuture defaults to false
rejectDatesInThePast: {Boolean}. Are dates in the past valid? rejectDatesInThePast defaults to false

---

Parameters:

{integer} year,

preferably 4-digit

{integer} month

{integer} day

Returns:

{Boolean}

---

Parameters:

text

---

Parameters:

{String|Form Node} Form

node or its ID

Returns:

{Object} Object containing 2 elements: Object.result is a boolean to indicate whether any fields in the form failed validation Object.failedValidations will contain info detailing any form fields with failed validations

---

Parameters:

text

---

Parameters:

{Event Object} e

---

Parameters:

{string} text

max

---

Parameters:

{string} text

min

---

Parameters:

{string} text

---

Parameters:

{String} text

{Object} Argument

object. The following options are supported:
args.minLength: Minlength for the password
args.minStrength: Minimum strength for the password to validate. This is a number from 1 to 4 to indicate how many character types it must have.
args.mustMatch: Array of character types which password must have to validate. For example, to require all 4 you would use args.mustMatch = ['hasUpper','hasLower', 'hasDigit','hasSpecial']
args.strong: Used for password meter. Array of numbers determining what qualifies as a "strong" password. For example: args.strong = [4] // All 4 char types
args.medium: Used for password meter. Array of numbers determining what qualifies as a "medium" password. For example: args.medium = [2,3] // 2 or 3 char types If a password doesn't qualify as strong or medium, then it defaults to weak.

---

Parameters:

{string} text

{object} optional

object containing regex settings. Supports "errorOnMatch" and "modifiers"

---

Parameters:

{string} text

---

Parameters:

e

---

Parameters:

{string} text

---

Parameters:

{String} text

to be validated

{Object} Options

object containing any of the following options:
timeIsRequired: {Boolean} Is a date which is provided without an accompanying time considered a valid timestamp? timeIsRequired defaults to false.
timeUnits: {String} A string containing a list of all the time units which are allowed to be entered in the timestamp. These may include any of the following: h for hours, m for minutes, s for seconds, u for microseconds, and t for timezone. Example: "hms" for hours, minutes and seconds or "hmsut" for all 5 units. Defaults to "hms"
microsecondPrecision {Integer} Indicates the supported number of decimal places for the microseconds. Defaults to 6.

---

Parameters:

{string} text

---

Parameters:

{string} text

---

Parameters:

{string} text

---

Parameters:

{string} text

---

Parameters:

{Event|String} Event

object or Node ID

{String} Custom

Event

{Number} ajaxLookupIndex

---