Difference between revisions of "NATS4 Form Validation"
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{NATS4 Manual | {{NATS4 Manual | ||
| show_sites_admin_section = true | | show_sites_admin_section = true | ||
| + | | show_skins_and_templates_admin_section = true | ||
}} | }} | ||
| + | = Form Inputs = | ||
[[NATS]] forms have built in validation checks on form fields. These require that the form be submitted for NATS to validate them. For example, on the join form, you will see that the input names have the following structure:<br> | [[NATS]] forms have built in validation checks on form fields. These require that the form be submitted for NATS to validate them. For example, on the join form, you will see that the input names have the following structure:<br> | ||
| − | + | ''<nowiki>signup[username:1:6:16:::username_check]</nowiki>'' | |
"signup" is the array that contains all submitted inputs. The format for each is: | "signup" is the array that contains all submitted inputs. The format for each is: | ||
| Line 11: | Line 13: | ||
# minimum - the minimum length of the input | # minimum - the minimum length of the input | ||
# maximum - the maximum length of the input | # maximum - the maximum length of the input | ||
| − | # compare - you can specify another input name here to compare the values. If set, the two | + | # compare - you can specify another input name here to compare the values. If set, the two input values must match |
| − | # session compare - you can specify a session variable name here to compare to the input value. If set, the input must match the session variable's value | + | # session compare - you can specify a session variable name here to compare to the input value. If set, the input value must match the session variable's value |
| − | # special check - you can specify a check function for NATS to run on the input. | + | # special check - you can specify a check function, or multiple check functions (separated by a comma) for NATS to run on the input. |
| + | |||
| + | = Check Functions = | ||
| + | The avaialble check functions are detailed below. Some allow you to pass additional arguments to customize the behavior of the check function. | ||
| + | |||
| + | == username_check == | ||
| + | This function will check that the input only consists of characters and numbers and starts with a character. | ||
== username_check_detailed == | == username_check_detailed == | ||
| Line 32: | Line 40: | ||
# There must be at least 9 lower case | # There must be at least 9 lower case | ||
<br> | <br> | ||
| + | |||
| + | == password_check == | ||
| + | This function will check that the input only consists of characters and numbers. | ||
== password_check_detailed == | == password_check_detailed == | ||
| Line 51: | Line 62: | ||
# There must be at least 3 Special Characters | # There must be at least 3 Special Characters | ||
# Any Alphabetic characters must be uppercase | # Any Alphabetic characters must be uppercase | ||
| + | |||
| + | == email_check == | ||
| + | Checks the input using a regular expression to determine if it is a valid email. This function does not perform domain checking. | ||
== strong_email_check == | == strong_email_check == | ||
| Line 58: | Line 72: | ||
http://php.net/manual/en/function.getmxrr.php | http://php.net/manual/en/function.getmxrr.php | ||
| − | This check does not take | + | == substring_check == |
| + | This check takes another input name as an argument. For example: | ||
| + | ''<nowiki>signup[password:1:6:16:::password_check,substring_check;username]</nowiki>'' | ||
| + | In the above example the password input will have the normal password_check run, then it will do the substring_check to ensure the password does not have a part that matches the username input. | ||
| + | |||
| + | == url_check == | ||
| + | Checks that the input is a valid URL. | ||
| + | |||
| + | == not_numeric_check == | ||
| + | Checks if the input contains any numbers. | ||
| + | |||
| + | == alnum_check == | ||
| + | Ensures input only consists of alphanumeric characters and underscores. | ||
| + | |||
| + | == alnum_space_check == | ||
| + | Ensures input only consists of alphanumeric characters, underscores, and spaces. | ||
| + | |||
| + | == alnum_letter_check == | ||
| + | Ensures input only consists of alphanumeric characters and underscores, and starts with a character. | ||
| + | |||
| + | == alnum_letter_space_check == | ||
| + | Ensures input only consists of alphanumeric characters, underscores, spaces, and starts with a character. | ||
| + | |||
| + | == age_check == | ||
| + | The iput for this check must be a date in the format of: <br> | ||
| + | Y-m-d (1985-05-13) | ||
| + | |||
| + | The function will take this input as the birth date and compare the date to now, to determine the age of the user. The function will then compare the resulting age to your configuration setting "$config['MIN_AGE']". If the age of the user is less than the configuration, NATS will return an error:<br> | ||
| + | |||
| + | "You have to be at least $config[MIN_AGE] years old to join!"" | ||
| + | |||
| + | == mod10_check == | ||
| + | Uses the mod10 algorithm to check for a valid credit card number. | ||
Latest revision as of 18:48, 5 December 2016
Form Inputs
NATS forms have built in validation checks on form fields. These require that the form be submitted for NATS to validate them. For example, on the join form, you will see that the input names have the following structure:
signup[username:1:6:16:::username_check]
"signup" is the array that contains all submitted inputs. The format for each is:
- name of the input - In this example: username
- required flag - If set to 1, this input must be submitted
- minimum - the minimum length of the input
- maximum - the maximum length of the input
- compare - you can specify another input name here to compare the values. If set, the two input values must match
- session compare - you can specify a session variable name here to compare to the input value. If set, the input value must match the session variable's value
- special check - you can specify a check function, or multiple check functions (separated by a comma) for NATS to run on the input.
Check Functions
The avaialble check functions are detailed below. Some allow you to pass additional arguments to customize the behavior of the check function.
username_check
This function will check that the input only consists of characters and numbers and starts with a character.
username_check_detailed
You can set detailed limitations on usernames by passing arguments to the special check function. For example:
[username:1:6:16:::username_check_detailed;1|4|9|||]
The details after the "username_check_detailed;" separated by a pipe "|" define the arguments:
- (Flag 1 or 0) - Defines whether or not the first character MUST be a letter
- (Numeric) - Defines the minimum number of upper case characters there needs to be
- (Numeric) - Defines the minimum number of lower case characters there needs to be
- (Numeric) - Defines the minimum number of Numbers (0-9) there needs to be
- (Flag 1 or 0) - Defines whether or not all characters MUST be upper case (This overrides the numeric lower case check)
- (Flag 1 or 0) - Defines whether or not all characters MUST be lower case (This overrides the numeric upper case check)
In the example above, the limitations set for the Username are:
- The first character must be a letter
- There must be at least 4 upper case letters
- There must be at least 9 lower case
password_check
This function will check that the input only consists of characters and numbers.
password_check_detailed
You can set detailed limitations on passwords by passing arguments to the special check function. For example:
[password:1:6:16:::password_check_detailed;1|||5|3|1|]
The details after the "password_check_detailed;" separated by a pipe "|" define the arguments:
- (Flag 1 or 0) - Defines whether or not the first character MUST be a letter.
- (Numeric) - Defines the minimum number of upper case characters there needs to be.
- (Numeric) - Defines the minimum number of lower case characters there needs to be.
- (Numeric) - Defines the minimum number of Numbers (0-9) there needs to be.
- (Numeric) - Defines the minimum number of Special Characters there needs to be (Anything that is not a letter or a number).
- (Flag 1 or 0) - Defines whether or not all characters MUST be upper case (This overrides the numeric lower case check).
- (Flag 1 or 0) - Defines whether or not all characters MUST be lower case (This overrides the numeric upper case check).
In the example above, the limitations set for the Password are:
- The first character must be a letter
- There must be at least 5 Numeric Characters
- There must be at least 3 Special Characters
- Any Alphabetic characters must be uppercase
email_check
Checks the input using a regular expression to determine if it is a valid email. This function does not perform domain checking.
strong_email_check
If you are using this check, you will want to ensure the "dns-search" directive on your server is turned off. This can create issues with the function called in this check.
You can add the check "strong_email_check" to have the domain of the email (everything after the @) checked for MX records using the PHP function getmxrr: http://php.net/manual/en/function.getmxrr.php
substring_check
This check takes another input name as an argument. For example: signup[password:1:6:16:::password_check,substring_check;username] In the above example the password input will have the normal password_check run, then it will do the substring_check to ensure the password does not have a part that matches the username input.
url_check
Checks that the input is a valid URL.
not_numeric_check
Checks if the input contains any numbers.
alnum_check
Ensures input only consists of alphanumeric characters and underscores.
alnum_space_check
Ensures input only consists of alphanumeric characters, underscores, and spaces.
alnum_letter_check
Ensures input only consists of alphanumeric characters and underscores, and starts with a character.
alnum_letter_space_check
Ensures input only consists of alphanumeric characters, underscores, spaces, and starts with a character.
age_check
The iput for this check must be a date in the format of:
Y-m-d (1985-05-13)
The function will take this input as the birth date and compare the date to now, to determine the age of the user. The function will then compare the resulting age to your configuration setting "$config['MIN_AGE']". If the age of the user is less than the configuration, NATS will return an error:
"You have to be at least $config[MIN_AGE] years old to join!""
mod10_check
Uses the mod10 algorithm to check for a valid credit card number.
