Class FormValidator

Object
   |
   +--FormValidator

class FormValidator

Defined in validator.js

Field Detail

emptyLabels

Array emptyLabels

Set of empty mandatory fields

errorDisplayOptions

Object errorDisplayOptions

Error summary properties

frm

Object frm

Form reference

messages

Array messages

Set of error messages

validators

Array validators

Set of validators

LIST_BULLET

<static> Number LIST_BULLET

Unordered lists must be used to display the summary items

LIST_FLOW

<static> Number LIST_FLOW

Summary items must be displayed inside an HTML table

MODE_ALERT

<static> Number MODE_ALERT

Errors summary must be reported using an alert box

MODE_DHTML

<static> Number MODE_DHTML

Errors summary must be displayed inside some page's node (inline)

FormValidator

FormValidator(<Object> frm)

The FormValidator class executes validation routines on fields of a given form. It's able to execute a chain of validators, collecting their results and error messages. The errors summary can be displayed using alert boxes or DHTML

Parameters:
frm - Form reference or id

add

void add(<String> field, <Function> validator, <Object> args)

Adds a new validator in the validation chain. For more details about the validator arguments, please consult project docs

Parameters:
field - Field name
validator - Validator
args - Hash of validator arguments

buildErrors

String buildErrors()

Builds a string buffer containing the error message(s)

clearErrors

void clearErrors()

Clears the target node used to display the error message(s)

onAfterValidate

Boolean onAfterValidate(<FormValidator> self)

This abstract method can be overriden to define extra validation routines. It's also used by PHP2Go forms API to evalute the VALIDATEFUNC attribute from the XML specification

Parameters:
self - FormValidator instance

onBeforeValidate

void onBeforeValidate(<FormValidator> self)

Used by the forms API to apply transformations in some fields values (upper, lower, trim, capitalize) before submission

Parameters:
self - FormValidator instance

run

void run(<Event> e)

This method runs all the registered validators, collecting the produced error messages. For validators that validate field's obligatoriness, the field label is also pushed onto a stack. The first empty and the first invalid fields are detected, so that we can determine which field must focused when displaying the errors summary

Parameters:
e - Event reference

setErrorDisplayOptions

void setErrorDisplayOptions(<Number> mode, <Object> target, <Boolean> showAll, <Number> list, <String> header)

Configures how validation error(s) must be displayed

Parameters:
mode - Display mode (MODE_ALERT or MODE_DHTML)
target - Container node (id or reference)
showAll - Show all errors or just the first one
list - List mode (LIST_FLOW or LIST_BULLET)
header - Summary header

setup

void setup()

Register an onsubmit event listener in the form. This listener is bound with the FormValidator.run() method

showErrors

void showErrors()

Shows the error message(s) using an alert box (MODE_ALERT) or a given target node (MODE_DHTML)