diff --git a/README.md b/README.md index e02a533..e1e957b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# jQuery Form Validator +# jQuery Form Validator [DISCONTINUED] *Validation framework that let's you configure, rather than code, your validation logic.* I started writing this plugin back in 2009 and it has given me much joy over the years. But all good things must come to an end and now it's time for this plugin to pull in its oars and go down with history. -**NOTICE!** This plugin is no longer being developed! It supports jQuery v. 1.8 >= 2.2.4. No pull requests will become merged in but feel free to fork and do whatever you like! +**This plugin is no longer being developed!** It supports jQuery v. 1.8 >= 2.2.4. No pull requests will become merged in but feel free to fork and do whatever you like! [](https://travis-ci.org/victorjonsson/jQuery-Form-Validator/builds/) @@ -82,13 +82,13 @@ Read the documentation for the default features at [#default-validators](#defaul * **letternumeric** — *Validate that the input value consists out of only letters and/or numbers* * **recaptcha** - *Validate Google [reCaptcha 2](https://www.google.com/recaptcha/intro/index.html)* -Read the documentation for the security module at [http://formvalidator.net/#security-validators](http://formvalidator.net/#security-validators) +Read the documentation for the security module at [#security-validators](#security-validators) ### Module: date * **time** — *hh:mm* * **birthdate** — *yyyy-mm-dd, not allowing dates in the future or dates that's older than 122 years (format can be customized, more information below)* -Read the documentation for the date module at [http://formvalidator.net/#date-validators](http://formvalidator.net/#date-validators) +Read the documentation for the date module at [#date-validators](#date-validators) ### Module: location * **country** @@ -97,7 +97,7 @@ Read the documentation for the date module at [http://formvalidator.net/#date-va * Suggest countries (english only) * Suggest states in the US -Read the documentation for the location module at [http://formvalidator.net/#location-validators](http://formvalidator.net/#location-validators) +Read the documentation for the location module at [#location-validators](/#location-validators) ### Module: file * **mime** @@ -105,14 +105,14 @@ Read the documentation for the location module at [http://formvalidator.net/#loc * **size** (file size) * **dimension** (size dimension and ratio) -Read the documentation for the file module at [http://formvalidator.net/#file-validators](http://formvalidator.net/#file-validators) +Read the documentation for the file module at [#file-validators](#file-validators) ### Module: logic * **Dependent validation** * **Require "one-of"** -Read the documentation for this module at [http://formvalidator.net/#logic](http://www.formvalidator.net/#logic) +Read the documentation for this module at [/#logic](#logic) ### Module: sepa @@ -487,6 +487,477 @@ You can tell any validator to ignore certain characters by using the attribute d
``` +## Security validators< + +### Password confirmation + +This validator can be used to validate that the values of two inputs are the same. The first input should have a name suffixed with _confirmation and the second should have the same name but without the suffix. + +``` ++ Password (at least 8 characters) + + + Confirm password + +
+``` + +``` ++ E-mail + + + Repeat e-mail + +
+``` + +### Password strength + +Use this validator to make sure that your user has a strong enough password. Set attributedata-validation-strength
to 1, 2 or 3 depending on how strong password you require.
+
+If you want the strength of the password to be displayed while the user types you call displayPasswordStrength()
in the end of the form.
+
+```
+
+
+
+
+
+```
+
+### Server side validation
+
+By using this validator you can validate the value given by the user on the server before the form gets submitted. The validation function will send a POST request to the URL declared in data-validation-url
. The argument posted to the URL will have the same name as the input being validated.
+
+The form will get the class validating-server-side while the server is being requested.
+
+The response from the validation script must be a JSON formatted object, containing the properties "valid" and "message".
+
+```
+{
+ "valid" : true|false,
+ "message" : "String with text that should be displayed as error message"
+}
+```
+
+#### Form
+
+```
+
+```
+
+#### /validate-input.php
+
+```
+ false,
+ 'message' => 'Post argument "user" is missing.'
+);
+
+if( isset($_POST['user']) ) {
+ $userRepo = new UserRepository( DataStorage::instance() );
+ $user = $userRepo->loadUser( $_POST['user'] );
+
+ if( $user ) {
+ // User name is registered on another account
+ $response = array('valid' => false, 'message' => 'This user name is already registered.');
+ } else {
+ // User name is available
+ $response = array('valid' => true);
+ }
+}
+echo json_encode($response);
+```
+
+**Modifying the server request**
+
+The parameter containing the input value, sent to the server, will by default have the same name as the input. You can however set your own parameter name by using the attribute data-validation-param-name
. You can also send along other parameters to the server by using the attribute data-validation-req-params
.
+
+```
+$user->get('ID')));
+?>
++ E-mail: + +
+``` + +### Credit card validation + +This validator makes it possible to validate any of the credit cards VISA, Mastercard, Diners club, Maestro, CJB, Discover and American express + +``` +<-- Accept credit card number from Visa, Mastercard and American Express --> ++ Credit card number + +
++ Security code (cvv) + +
+``` + +You can also let the user choose a credit card and programmatically change the allowed credit card on the input of the card number. + +``` ++ Credit card + +
++ Credit card number + +
+... + + +``` + +### Simple captcha + +``` + + +``` + +### Google reCAPTCHA + +Use this validator if wanting to integrate the Google service reCAPTCHA. + +``` ++ +
+``` + +You can also use the setup function to configure the recaptcha service. + +``` +$.validate({ + reCaptchaSiteKey: '...', + reCaptchaTheme: 'light' +}); +``` + +### Letters and numbers + +By using the validatorletternumeric
you can validate that given input value only contains letters and/or numbers. This validator allows any type of character in contrast to the alphanumeric validator, which only allows letters A-Z.
+
+```
+
+
+
+
+
+```
+
+## Date validators
+
+### Birthdate
+
+This validator is the same as the default date validator except that it only allows past dates and dates that is not older than 120 years.
+
+```
+
+
+
+
+
+
+
+
+```
+
+## Time
+
+```
+
+
+```
+
+
+## Location validators
+
+### Country
+
+```
+
+
+```
+
+### State (US)
+
+```
+
+
+```
+
+### Longitude and Latitude
+
+```
+
+
+```
+
+### Suggest country/state
+
+By using this function you'll make it easier for your visitor to input a country or state.
+
+```
+
+
+
+
+
+```
+
+## File validators
+
+### File size
+
+This validation is only supported by Internet Explorer 10, Mozilla FireFox v >= 3.6 and any of the later versions of webkit based browsers.
+
+```
+
+
+
+
+
+```
+
+### File type
+
+This validation will fall back on checking the file extension in older browsers. In modern browsers the validation will check that any of the extensions in data-validation-allowing
exists in the mime type declaration of the file. This means that data-validation-allowing="pdf"
will work in both modern browsers (checking against "application/pdf") and older browsers (checking the file extension ".pdf").
+
+```
+
+
+
+
+
+```
+
+Validating multiple files (with separate error messages depending on failed validation):
+
+```
+
+```
+
+### Image dimension and ratio
+
+Use the validator dimension
to check the dimension of an image (jpg, gif or png).
+
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+```
+
+Use the attribute data-validation-ratio
to validate that the uploaded image has a certain ratio
+
+```
+
+
+
+
+
+```
+
+## Logic
+
+### Validators depending on each other
+
+Use the attributes data-validation-depends-on
to configure that an input is optional as long as another input is left without an answer.
+
+```
+
++ Contact me: + +
++ E-mail: + +
+``` + +``` + ++ Country: + +
+ ++ State: + +
+ +... + + + +``` + +### Require only one out of several inputs + +Use the attributedata-validation-optional-if-answered
to tell the validator that only one, out of a group of inputs, requires an answer.
+
+```
++ Home phone number: + +
++ Cell phone number: + +
++ Work phone number: + +
+ +``` + ## Changelog #### 2.3.19